Cloud Security Compliance V1 API - Class Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client (v0.1.0)

Reference documentation and code samples for the Cloud Security Compliance V1 API class Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.

REST client for the Config service.

Config Service manages compliance frameworks, cloud controls, and their configurations.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Config Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all Config clients
::Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Config Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_cloud_control

def create_cloud_control(request, options = nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::CloudControl
def create_cloud_control(parent: nil, cloud_control_id: nil, cloud_control: nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::CloudControl

Creates a new CloudControl with type Custom under a given parent resource. Built-in CloudControls are managed by Google and cannot be created through this API.

Overloads 
def create_cloud_control(request, options = nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::CloudControl
Pass arguments to create_cloud_control via a request object, either of type Google::Cloud::CloudSecurityCompliance::V1::CreateCloudControlRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CloudSecurityCompliance::V1::CreateCloudControlRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_cloud_control(parent: nil, cloud_control_id: nil, cloud_control: nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::CloudControl
Pass arguments to create_cloud_control via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource name, in the format organizations/{organization}/locations/{location}.
  • cloud_control_id (::String) — Required. ID of the CloudControl. This is the last segment of the CloudControl resource name. Format: ^[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$.
  • cloud_control (::Google::Cloud::CloudSecurityCompliance::V1::CloudControl, ::Hash) — Required. The resource being created
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/cloud_security_compliance/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudSecurityCompliance::V1::CreateCloudControlRequest.new

# Call the create_cloud_control method.
result = client.create_cloud_control request

# The returned object is of type Google::Cloud::CloudSecurityCompliance::V1::CloudControl.
p result

#create_framework

def create_framework(request, options = nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework
def create_framework(parent: nil, framework_id: nil, framework: nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework

Creates a new Framework with type Custom under a given parent resource. Frameworks with type Built-in are managed by Google and cannot be created through this API.

Overloads 
def create_framework(request, options = nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework
Pass arguments to create_framework via a request object, either of type Google::Cloud::CloudSecurityCompliance::V1::CreateFrameworkRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CloudSecurityCompliance::V1::CreateFrameworkRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_framework(parent: nil, framework_id: nil, framework: nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework
Pass arguments to create_framework via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource name, in the format organizations/{organization}/locations/{location}.
  • framework_id (::String) — Required. ID of the framework. This is not the full name of the framework. This is the last part of the full name of the framework.
  • framework (::Google::Cloud::CloudSecurityCompliance::V1::Framework, ::Hash) — Required. The resource being created
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/cloud_security_compliance/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudSecurityCompliance::V1::CreateFrameworkRequest.new

# Call the create_framework method.
result = client.create_framework request

# The returned object is of type Google::Cloud::CloudSecurityCompliance::V1::Framework.
p result

#delete_cloud_control

def delete_cloud_control(request, options = nil) -> ::Google::Protobuf::Empty
def delete_cloud_control(name: nil) -> ::Google::Protobuf::Empty

Deletes a single Custom CloudControl, including all its major and minor revisions.

  • This operation can only be performed on CloudControls with type CUSTOM. Built-in CloudControls cannot be deleted.
  • The CloudControl cannot be deleted if any of its revisions are currently referenced by any Framework.
  • This action is permanent and cannot be undone.
Overloads 
def delete_cloud_control(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_cloud_control via a request object, either of type DeleteCloudControlRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CloudSecurityCompliance::V1::DeleteCloudControlRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_cloud_control(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_cloud_control via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. Name of the resource, in the format organizations/{organization}/locations/{location}/CloudControls/{CloudControl}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/cloud_security_compliance/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudSecurityCompliance::V1::DeleteCloudControlRequest.new

# Call the delete_cloud_control method.
result = client.delete_cloud_control request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_framework

def delete_framework(request, options = nil) -> ::Google::Protobuf::Empty
def delete_framework(name: nil) -> ::Google::Protobuf::Empty

Deletes a single Custom Framework, including all its minor and minor revisions.

  • This operation can only be performed on Frameworks with type CUSTOM. Built-in Frameworks cannot be deleted.
  • The Framework cannot be deleted if it is currently deployed on any resource.
  • This action is permanent and cannot be undone.
Overloads 
def delete_framework(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_framework via a request object, either of type DeleteFrameworkRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CloudSecurityCompliance::V1::DeleteFrameworkRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_framework(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_framework via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. Name of the resource, in the format organizations/{organization}/locations/{location}/frameworks/{framework}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/cloud_security_compliance/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudSecurityCompliance::V1::DeleteFrameworkRequest.new

# Call the delete_framework method.
result = client.delete_framework request

# The returned object is of type Google::Protobuf::Empty.
p result

#get_cloud_control

def get_cloud_control(request, options = nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::CloudControl
def get_cloud_control(name: nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::CloudControl

Gets details of a single CloudControl. This method retrieves a CloudControl resource, which can be either Built-in or Custom, identified by its name.

By default, the latest major version of the CloudControl is returned. A specific major version can be retrieved by specifying the major_revision_id in the request.

Overloads 
def get_cloud_control(request, options = nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::CloudControl
Pass arguments to get_cloud_control via a request object, either of type GetCloudControlRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CloudSecurityCompliance::V1::GetCloudControlRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_cloud_control(name: nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::CloudControl
Pass arguments to get_cloud_control via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the cloudcontrol to retrieve in the format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/cloud_security_compliance/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudSecurityCompliance::V1::GetCloudControlRequest.new

# Call the get_cloud_control method.
result = client.get_cloud_control request

# The returned object is of type Google::Cloud::CloudSecurityCompliance::V1::CloudControl.
p result

#get_framework

def get_framework(request, options = nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework
def get_framework(name: nil, major_revision_id: nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework

Gets details of a single Framework. This method retrieves a Framework resource, which can be either Built-in or Custom, identified by its name.

By default, the latest major version of the Framework is returned. A specific major version can be retrieved by specifying the major_revision_id in the request.

Overloads 
def get_framework(request, options = nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework
Pass arguments to get_framework via a request object, either of type GetFrameworkRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CloudSecurityCompliance::V1::GetFrameworkRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_framework(name: nil, major_revision_id: nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework
Pass arguments to get_framework via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the framework to retrieve. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id}
  • major_revision_id (::Integer) — Optional. The Framework major version to retrieve. If not specified, the most recently updated revision_id is retrieved.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/cloud_security_compliance/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudSecurityCompliance::V1::GetFrameworkRequest.new

# Call the get_framework method.
result = client.get_framework request

# The returned object is of type Google::Cloud::CloudSecurityCompliance::V1::Framework.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new Config REST client object.

Yields
  • (config) — Configure the Config client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_cloud_controls

def list_cloud_controls(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::CloudSecurityCompliance::V1::CloudControl>
def list_cloud_controls(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::CloudSecurityCompliance::V1::CloudControl>

Lists all CloudControls (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each CloudControl is returned.

Overloads 
def list_cloud_controls(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::CloudSecurityCompliance::V1::CloudControl>
Pass arguments to list_cloud_controls via a request object, either of type ListCloudControlsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CloudSecurityCompliance::V1::ListCloudControlsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_cloud_controls(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::CloudSecurityCompliance::V1::CloudControl>
Pass arguments to list_cloud_controls via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource name, in the format organizations/{organization}/locations/{location}.
  • page_size (::Integer) — Optional. The maximum number of CloudControls to return. The default value is 500.

    If you exceed the maximum value of 1000, then the service uses the maximum value.

  • page_token (::String) — Optional. A pagination token returned from a previous request to list CloudControls. Provide this token to retrieve the next page of results.

    When paginating, parent provided to ListCloudControls request must match the call that provided the page token.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/cloud_security_compliance/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudSecurityCompliance::V1::ListCloudControlsRequest.new

# Call the list_cloud_controls method.
result = client.list_cloud_controls request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::CloudSecurityCompliance::V1::CloudControl.
  p item
end

#list_frameworks

def list_frameworks(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::CloudSecurityCompliance::V1::Framework>
def list_frameworks(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::CloudSecurityCompliance::V1::Framework>

Lists all Frameworks (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each Framework is returned.

Overloads 
def list_frameworks(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::CloudSecurityCompliance::V1::Framework>
Pass arguments to list_frameworks via a request object, either of type ListFrameworksRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CloudSecurityCompliance::V1::ListFrameworksRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_frameworks(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::CloudSecurityCompliance::V1::Framework>
Pass arguments to list_frameworks via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource name, in the format organizations/{organization}/locations/{location}. Only global location is supported.
  • page_size (::Integer) — Optional. The maximum number of frameworks to return. The default value is 500.

    If you exceed the maximum value of 1000, then the service uses the maximum value.

  • page_token (::String) — Optional. A pagination token returned from a previous request to list frameworks. Provide this token to retrieve the next page of results.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/cloud_security_compliance/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudSecurityCompliance::V1::ListFrameworksRequest.new

# Call the list_frameworks method.
result = client.list_frameworks request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::CloudSecurityCompliance::V1::Framework.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_cloud_control

def update_cloud_control(request, options = nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::CloudControl
def update_cloud_control(update_mask: nil, cloud_control: nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::CloudControl

Updates a single CloudControl. This method allows for partial updates of a Custom CloudControl resource. Built-in CloudControls cannot be updated.

  • If an update_mask is provided, only the fields specified in the mask will be updated.
  • If no update_mask is provided, all fields present in the request's cloud_control body will be used to overwrite the existing resource.

A successful update will result in a new version of the CloudControl.

Overloads 
def update_cloud_control(request, options = nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::CloudControl
Pass arguments to update_cloud_control via a request object, either of type UpdateCloudControlRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CloudSecurityCompliance::V1::UpdateCloudControlRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_cloud_control(update_mask: nil, cloud_control: nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::CloudControl
Pass arguments to update_cloud_control via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) —

    Optional. Field mask is used to specify the fields to be overwritten in the CloudControl resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. The fields that can be updated are:

    1. Display_name
    2. Description
    3. Parameters
    4. Rules
    5. ParameterSpec.
  • cloud_control (::Google::Cloud::CloudSecurityCompliance::V1::CloudControl, ::Hash) — Required. The resource being updated
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/cloud_security_compliance/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudSecurityCompliance::V1::UpdateCloudControlRequest.new

# Call the update_cloud_control method.
result = client.update_cloud_control request

# The returned object is of type Google::Cloud::CloudSecurityCompliance::V1::CloudControl.
p result

#update_framework

def update_framework(request, options = nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework
def update_framework(update_mask: nil, framework: nil, major_revision_id: nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework

Updates a single Framework. This method allows for partial updates of a Framework resource. The fields to be updated are specified using the update_mask.

  • If an update_mask is provided, only the fields specified in the mask will be updated.
  • If no update_mask is provided, all fields present in the request's framework body will be used to overwrite the existing resource.

This operation can only be performed on Frameworks with type CUSTOM. A successful update will result in a new version of the Framework.

Overloads 
def update_framework(request, options = nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework
Pass arguments to update_framework via a request object, either of type UpdateFrameworkRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::CloudSecurityCompliance::V1::UpdateFrameworkRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_framework(update_mask: nil, framework: nil, major_revision_id: nil) -> ::Google::Cloud::CloudSecurityCompliance::V1::Framework
Pass arguments to update_framework via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask is used to specify the fields to be overwritten in the Framework resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
  • framework (::Google::Cloud::CloudSecurityCompliance::V1::Framework, ::Hash) — Required. The resource being updated
  • major_revision_id (::Integer) — Optional. The major version ID of the framework to update.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/cloud_security_compliance/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudSecurityCompliance::V1::UpdateFrameworkRequest.new

# Call the update_framework method.
result = client.update_framework request

# The returned object is of type Google::Cloud::CloudSecurityCompliance::V1::Framework.
p result