Reference documentation and code samples for the Cloud Security Compliance API module Google::Cloud::CloudSecurityCompliance.
Methods
.config
def self.config(version: :v1, transport: :grpc, &block) -> ::Object
Create a new client object for Config.
By default, this returns an instance of
Google::Cloud::CloudSecurityCompliance::V1::Config::Client
for a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in the
version
parameter. If the Config service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
You can also specify a different transport by passing :rest
or :grpc
in
the transport
parameter.
Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Config service. You can determine whether the method will succeed by calling CloudSecurityCompliance.config_available?.
About Config
Config Service manages compliance frameworks, cloud controls, and their configurations.
-
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to
:v1
. -
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to
:grpc
.
- (::Object) — A client object for the specified version.
.config_available?
def self.config_available?(version: :v1, transport: :grpc) -> boolean
Determines whether the Config service is supported by the current client. If true, you can retrieve a client object by calling CloudSecurityCompliance.config. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Config service, or if the versioned client gem needs an update to support the Config service.
-
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to
:v1
. -
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to
:grpc
.
- (boolean) — Whether the service is available.
.configure
def self.configure() -> ::Google::Cloud::Config
Configure the google-cloud-cloud_security_compliance library.
The following configuration parameters are supported:
credentials
(type:String, Hash, Google::Auth::Credentials
) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.lib_name
(type:String
) - The library name as recorded in instrumentation and logging.lib_version
(type:String
) - The library version as recorded in instrumentation and logging.interceptors
(type:Array<GRPC::ClientInterceptor>
) - An array of interceptors that are run before calls are executed.timeout
(type:Numeric
) - Default timeout in seconds.metadata
(type:Hash{Symbol=>String}
) - Additional headers to be sent with the call.retry_policy
(type:Hash
) - The retry policy. The value is a hash with the following keys::initial_delay
(type:Numeric
) - The initial delay in seconds.:max_delay
(type:Numeric
) - The max delay in seconds.:multiplier
(type:Numeric
) - The incremental backoff multiplier.:retry_codes
(type:Array<String>
) - The error codes that should trigger a retry.
- (::Google::Cloud.configure.cloud_security_compliance)
- (::Google::Cloud::Config) — The default configuration used by this library
.deployment
def self.deployment(version: :v1, transport: :grpc, &block) -> ::Object
Create a new client object for Deployment.
By default, this returns an instance of
Google::Cloud::CloudSecurityCompliance::V1::Deployment::Client
for a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in the
version
parameter. If the Deployment service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
You can also specify a different transport by passing :rest
or :grpc
in
the transport
parameter.
Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Deployment service. You can determine whether the method will succeed by calling CloudSecurityCompliance.deployment_available?.
About Deployment
Deployment service allows users to manage deployments of Frameworks and Cloud Controls on a target resource.
-
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to
:v1
. -
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to
:grpc
.
- (::Object) — A client object for the specified version.
.deployment_available?
def self.deployment_available?(version: :v1, transport: :grpc) -> boolean
Determines whether the Deployment service is supported by the current client. If true, you can retrieve a client object by calling CloudSecurityCompliance.deployment. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Deployment service, or if the versioned client gem needs an update to support the Deployment service.
-
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to
:v1
. -
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to
:grpc
.
- (boolean) — Whether the service is available.
Constants
VERSION
value: "0.1.0"