Security Command Center V2 API - Class Google::Cloud::SecurityCenter::V2::SecurityCenter::Client (v0.3.0)

Reference documentation and code samples for the Security Command Center V2 API class Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.

Client for the SecurityCenter service.

V2 APIs for Security Center service.

Inherits

Includes

Methods

.configure

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

Configure the SecurityCenter 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 SecurityCenter clients
::Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.configure do |config|
  config.timeout = 10.0
end

#batch_create_resource_value_configs

def batch_create_resource_value_configs(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::BatchCreateResourceValueConfigsResponse
def batch_create_resource_value_configs(parent: nil, requests: nil) -> ::Google::Cloud::SecurityCenter::V2::BatchCreateResourceValueConfigsResponse

Creates a ResourceValueConfig for an organization. Maps user's tags to difference resource values for use by the attack path simulation.

Overloads 
def batch_create_resource_value_configs(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::BatchCreateResourceValueConfigsResponse
Pass arguments to batch_create_resource_value_configs via a request object, either of type BatchCreateResourceValueConfigsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::BatchCreateResourceValueConfigsRequest, ::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 batch_create_resource_value_configs(parent: nil, requests: nil) -> ::Google::Cloud::SecurityCenter::V2::BatchCreateResourceValueConfigsResponse
Pass arguments to batch_create_resource_value_configs 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. Resource name of the new ResourceValueConfig's parent. The parent field in the CreateResourceValueConfigRequest messages must either be empty or match this field.
  • requests (::Array<::Google::Cloud::SecurityCenter::V2::CreateResourceValueConfigRequest, ::Hash>) — Required. The resource value configs to be created.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::BatchCreateResourceValueConfigsRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::BatchCreateResourceValueConfigsResponse.
p result

#bulk_mute_findings

def bulk_mute_findings(request, options = nil) -> ::Gapic::Operation
def bulk_mute_findings(parent: nil, filter: nil) -> ::Gapic::Operation

Kicks off an LRO to bulk mute findings for a parent based on a filter. If no location is specified, findings are muted in global. The parent can be either an organization, folder, or project. The findings matched by the filter will be muted after the LRO is done.

Overloads 
def bulk_mute_findings(request, options = nil) -> ::Gapic::Operation
Pass arguments to bulk_mute_findings via a request object, either of type BulkMuteFindingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::BulkMuteFindingsRequest, ::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 bulk_mute_findings(parent: nil, filter: nil) -> ::Gapic::Operation
Pass arguments to bulk_mute_findings 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, at which bulk action needs to be applied. If no location is specified, findings are updated in global. The following list shows some examples:

    • organizations/[organization_id]
    • organizations/[organization_id]/locations/[location_id]
    • folders/[folder_id]
    • folders/[folder_id]/locations/[location_id]
    • projects/[project_id]
    • projects/[project_id]/locations/[location_id]
  • filter (::String) —

    Expression that identifies findings that should be updated. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND.

    Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource.

    The supported operators are:

    • = for all value types.
    • >, <, >=, <= for integer values.
    • :, meaning substring matching, for strings.

    The supported value types are:

    • string literals in quotes.
    • integer literals without quotes.
    • boolean literals true and false without quotes.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::BulkMuteFindingsRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#configure

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

Configure the SecurityCenter 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_big_query_export

def create_big_query_export(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::BigQueryExport
def create_big_query_export(parent: nil, big_query_export: nil, big_query_export_id: nil) -> ::Google::Cloud::SecurityCenter::V2::BigQueryExport

Creates a BigQuery export.

Overloads 
def create_big_query_export(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::BigQueryExport
Pass arguments to create_big_query_export via a request object, either of type CreateBigQueryExportRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::CreateBigQueryExportRequest, ::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_big_query_export(parent: nil, big_query_export: nil, big_query_export_id: nil) -> ::Google::Cloud::SecurityCenter::V2::BigQueryExport
Pass arguments to create_big_query_export 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 name of the parent resource of the new BigQuery export. Its format is "organizations/[organization_id]/locations/[location_id]", "folders/[folder_id]/locations/[location_id]", or "projects/[project_id]/locations/[location_id]".
  • big_query_export (::Google::Cloud::SecurityCenter::V2::BigQueryExport, ::Hash) — Required. The BigQuery export being created.
  • big_query_export_id (::String) — Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::CreateBigQueryExportRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::BigQueryExport.
p result

#create_finding

def create_finding(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Finding
def create_finding(parent: nil, finding_id: nil, finding: nil) -> ::Google::Cloud::SecurityCenter::V2::Finding

Creates a finding in a location. The corresponding source must exist for finding creation to succeed.

Overloads 
def create_finding(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Finding
Pass arguments to create_finding via a request object, either of type CreateFindingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::CreateFindingRequest, ::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_finding(parent: nil, finding_id: nil, finding: nil) -> ::Google::Cloud::SecurityCenter::V2::Finding
Pass arguments to create_finding 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. Resource name of the new finding's parent. The following list shows some examples of the format: + organizations/[organization_id]/sources/[source_id] + organizations/[organization_id]/sources/[source_id]/locations/[location_id]
  • finding_id (::String) — Required. Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.
  • finding (::Google::Cloud::SecurityCenter::V2::Finding, ::Hash) — Required. The Finding being created. The name and security_marks will be ignored as they are both output only fields on this resource.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::CreateFindingRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::Finding.
p result

#create_mute_config

def create_mute_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig
def create_mute_config(parent: nil, mute_config: nil, mute_config_id: nil) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig

Creates a mute config.

Overloads 
def create_mute_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig
Pass arguments to create_mute_config via a request object, either of type CreateMuteConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::CreateMuteConfigRequest, ::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_mute_config(parent: nil, mute_config: nil, mute_config_id: nil) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig
Pass arguments to create_mute_config 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. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]/locations/[location_id]", "folders/[folder_id]/locations/[location_id]", or "projects/[project_id]/locations/[location_id]".
  • mute_config (::Google::Cloud::SecurityCenter::V2::MuteConfig, ::Hash) — Required. The mute config being created.
  • mute_config_id (::String) — Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::CreateMuteConfigRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::MuteConfig.
p result

#create_notification_config

def create_notification_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::NotificationConfig
def create_notification_config(parent: nil, config_id: nil, notification_config: nil) -> ::Google::Cloud::SecurityCenter::V2::NotificationConfig

Creates a notification config.

Overloads 
def create_notification_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::NotificationConfig
Pass arguments to create_notification_config via a request object, either of type CreateNotificationConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::CreateNotificationConfigRequest, ::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_notification_config(parent: nil, config_id: nil, notification_config: nil) -> ::Google::Cloud::SecurityCenter::V2::NotificationConfig
Pass arguments to create_notification_config 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. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]/locations/[location_id]", "folders/[folder_id]/locations/[location_id]", or "projects/[project_id]/locations/[location_id]".
  • config_id (::String) — Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters and contain alphanumeric characters, underscores, or hyphens only.
  • notification_config (::Google::Cloud::SecurityCenter::V2::NotificationConfig, ::Hash) — Required. The notification config being created. The name and the service account will be ignored as they are both output only fields on this resource.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::CreateNotificationConfigRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::NotificationConfig.
p result

#create_source

def create_source(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Source
def create_source(parent: nil, source: nil) -> ::Google::Cloud::SecurityCenter::V2::Source

Creates a source.

Overloads 
def create_source(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Source
Pass arguments to create_source via a request object, either of type CreateSourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::CreateSourceRequest, ::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_source(parent: nil, source: nil) -> ::Google::Cloud::SecurityCenter::V2::Source
Pass arguments to create_source 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. Resource name of the new source's parent. Its format should be "organizations/[organization_id]".
  • source (::Google::Cloud::SecurityCenter::V2::Source, ::Hash) — Required. The Source being created, only the display_name and description will be used. All other fields will be ignored.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::CreateSourceRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::Source.
p result

#delete_big_query_export

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

Deletes an existing BigQuery export.

Overloads 
def delete_big_query_export(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_big_query_export via a request object, either of type DeleteBigQueryExportRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::DeleteBigQueryExportRequest, ::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_big_query_export(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_big_query_export 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 BigQuery export to delete. The following list shows some examples of the format:

    + organizations/{organization}/locations/{location}/bigQueryExports/{export_id}

    • folders/{folder}/locations/{location}/bigQueryExports/{export_id}
    • projects/{project}/locations/{location}/bigQueryExports/{export_id}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::DeleteBigQueryExportRequest.new

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

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

#delete_mute_config

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

Deletes an existing mute config. If no location is specified, default is global.

Overloads 
def delete_mute_config(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_mute_config via a request object, either of type DeleteMuteConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::DeleteMuteConfigRequest, ::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_mute_config(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_mute_config 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 mute config to delete. The following list shows some examples of the format:

    • organizations/{organization}/muteConfigs/{config_id} + organizations/{organization}/locations/{location}/muteConfigs/{config_id}
    • folders/{folder}/muteConfigs/{config_id}
    • folders/{folder}/locations/{location}/muteConfigs/{config_id}
    • projects/{project}/muteConfigs/{config_id}
    • projects/{project}/locations/{location}/muteConfigs/{config_id}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::DeleteMuteConfigRequest.new

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

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

#delete_notification_config

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

Deletes a notification config.

Overloads 
def delete_notification_config(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_notification_config via a request object, either of type DeleteNotificationConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::DeleteNotificationConfigRequest, ::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_notification_config(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_notification_config 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 notification config to delete. The following list shows some examples of the format:

    + organizations/[organization_id]/locations/[location_id]/notificationConfigs/[config_id] + folders/[folder_id]/locations/[location_id]notificationConfigs/[config_id] + projects/[project_id]/locations/[location_id]notificationConfigs/[config_id]

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

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::DeleteNotificationConfigRequest.new

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

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

#delete_resource_value_config

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

Deletes a ResourceValueConfig.

Overloads 
def delete_resource_value_config(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_resource_value_config via a request object, either of type DeleteResourceValueConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::DeleteResourceValueConfigRequest, ::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_resource_value_config(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_resource_value_config 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 ResourceValueConfig to delete
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::DeleteResourceValueConfigRequest.new

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

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

#get_big_query_export

def get_big_query_export(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::BigQueryExport
def get_big_query_export(name: nil) -> ::Google::Cloud::SecurityCenter::V2::BigQueryExport

Gets a BigQuery export.

Overloads 
def get_big_query_export(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::BigQueryExport
Pass arguments to get_big_query_export via a request object, either of type GetBigQueryExportRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::GetBigQueryExportRequest, ::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_big_query_export(name: nil) -> ::Google::Cloud::SecurityCenter::V2::BigQueryExport
Pass arguments to get_big_query_export 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 BigQuery export to retrieve. The following list shows some examples of the format:

    + organizations/{organization}/locations/{location}/bigQueryExports/{export_id}

    • folders/{folder}/locations/{location}/bigQueryExports/{export_id}
    • projects/{project}locations/{location}//bigQueryExports/{export_id}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::GetBigQueryExportRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::BigQueryExport.
p result

#get_iam_policy

def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy

Gets the access control policy on the specified Source.

Overloads 
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::GetIamPolicyRequest, ::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_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
Pass arguments to get_iam_policy 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
  • resource (::String) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::GetIamPolicyRequest.new

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

# The returned object is of type Google::Iam::V1::Policy.
p result

#get_mute_config

def get_mute_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig
def get_mute_config(name: nil) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig

Gets a mute config. If no location is specified, default is global.

Overloads 
def get_mute_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig
Pass arguments to get_mute_config via a request object, either of type GetMuteConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::GetMuteConfigRequest, ::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_mute_config(name: nil) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig
Pass arguments to get_mute_config 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 mute config to retrieve. The following list shows some examples of the format:

    • organizations/{organization}/muteConfigs/{config_id} + organizations/{organization}/locations/{location}/muteConfigs/{config_id}
    • folders/{folder}/muteConfigs/{config_id}
    • folders/{folder}/locations/{location}/muteConfigs/{config_id}
    • projects/{project}/muteConfigs/{config_id}
    • projects/{project}/locations/{location}/muteConfigs/{config_id}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::GetMuteConfigRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::MuteConfig.
p result

#get_notification_config

def get_notification_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::NotificationConfig
def get_notification_config(name: nil) -> ::Google::Cloud::SecurityCenter::V2::NotificationConfig

Gets a notification config.

Overloads 
def get_notification_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::NotificationConfig
Pass arguments to get_notification_config via a request object, either of type GetNotificationConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::GetNotificationConfigRequest, ::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_notification_config(name: nil) -> ::Google::Cloud::SecurityCenter::V2::NotificationConfig
Pass arguments to get_notification_config 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 notification config to get. The following list shows some examples of the format:

    + organizations/[organization_id]/locations/[location_id]/notificationConfigs/[config_id] + folders/[folder_id]/locations/[location_id]/notificationConfigs/[config_id] + projects/[project_id]/locations/[location_id]/notificationConfigs/[config_id]

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

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::GetNotificationConfigRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::NotificationConfig.
p result

#get_resource_value_config

def get_resource_value_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::ResourceValueConfig
def get_resource_value_config(name: nil) -> ::Google::Cloud::SecurityCenter::V2::ResourceValueConfig

Gets a ResourceValueConfig.

Overloads 
def get_resource_value_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::ResourceValueConfig
Pass arguments to get_resource_value_config via a request object, either of type GetResourceValueConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::GetResourceValueConfigRequest, ::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_resource_value_config(name: nil) -> ::Google::Cloud::SecurityCenter::V2::ResourceValueConfig
Pass arguments to get_resource_value_config 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 value config to retrieve. Its format is organizations/{organization}/resourceValueConfigs/{config_id}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::GetResourceValueConfigRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::ResourceValueConfig.
p result

#get_simulation

def get_simulation(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Simulation
def get_simulation(name: nil) -> ::Google::Cloud::SecurityCenter::V2::Simulation

Get the simulation by name or the latest simulation for the given organization.

Overloads 
def get_simulation(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Simulation
Pass arguments to get_simulation via a request object, either of type GetSimulationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::GetSimulationRequest, ::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_simulation(name: nil) -> ::Google::Cloud::SecurityCenter::V2::Simulation
Pass arguments to get_simulation 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 organization name or simulation name of this simulation

    Valid format: "organizations/{organization}/simulations/latest" "organizations/{organization}/simulations/{simulation}"

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

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::GetSimulationRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::Simulation.
p result

#get_source

def get_source(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Source
def get_source(name: nil) -> ::Google::Cloud::SecurityCenter::V2::Source

Gets a source.

Overloads 
def get_source(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Source
Pass arguments to get_source via a request object, either of type GetSourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::GetSourceRequest, ::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_source(name: nil) -> ::Google::Cloud::SecurityCenter::V2::Source
Pass arguments to get_source 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. Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]".
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::GetSourceRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::Source.
p result

#get_valued_resource

def get_valued_resource(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::ValuedResource
def get_valued_resource(name: nil) -> ::Google::Cloud::SecurityCenter::V2::ValuedResource

Get the valued resource by name

Overloads 
def get_valued_resource(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::ValuedResource
Pass arguments to get_valued_resource via a request object, either of type GetValuedResourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::GetValuedResourceRequest, ::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_valued_resource(name: nil) -> ::Google::Cloud::SecurityCenter::V2::ValuedResource
Pass arguments to get_valued_resource 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 this valued resource

    Valid format: "organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}"

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

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::GetValuedResourceRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::ValuedResource.
p result

#group_findings

def group_findings(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::GroupResult>
def group_findings(parent: nil, filter: nil, group_by: nil, page_token: nil, page_size: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::GroupResult>

Filters an organization or source's findings and groups them by their specified properties in a location. If no location is specified, findings are assumed to be in global

To group across all sources provide a - as the source id. The following list shows some examples:

  • /v2/organizations/{organization_id}/sources/-/findings + /v2/organizations/{organization_id}/sources/-/locations/{location_id}/findings
  • /v2/folders/{folder_id}/sources/-/findings
  • /v2/folders/{folder_id}/sources/-/locations/{location_id}/findings
  • /v2/projects/{project_id}/sources/-/findings
  • /v2/projects/{project_id}/sources/-/locations/{location_id}/findings
Overloads 
def group_findings(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::GroupResult>
Pass arguments to group_findings via a request object, either of type GroupFindingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::GroupFindingsRequest, ::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 group_findings(parent: nil, filter: nil, group_by: nil, page_token: nil, page_size: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::GroupResult>
Pass arguments to group_findings 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. Name of the source to groupBy. If no location is specified, finding is assumed to be in global. The following list shows some examples:

    • organizations/[organization_id]/sources/[source_id] + organizations/[organization_id]/sources/[source_id]/locations/[location_id]
    • folders/[folder_id]/sources/[source_id]
    • folders/[folder_id]/sources/[source_id]/locations/[location_id]
    • projects/[project_id]/sources/[source_id]
    • projects/[project_id]/sources/[source_id]/locations/[location_id]

    To groupBy across all sources provide a source_id of -. The following list shows some examples:

    • organizations/{organization_id}/sources/-
    • organizations/{organization_id}/sources/-/locations/[location_id]
    • folders/{folder_id}/sources/-
    • folders/{folder_id}/sources/-/locations/[location_id]
    • projects/{project_id}/sources/-
    • projects/{project_id}/sources/-/locations/[location_id]
  • filter (::String) —

    Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND.

    Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. Examples include:

    • name
    • security_marks.marks.marka

    The supported operators are:

    • = for all value types.
    • >, <, >=, <= for integer values.
    • :, meaning substring matching, for strings.

    The supported value types are:

    • string literals in quotes.
    • integer literals without quotes.
    • boolean literals true and false without quotes.

    The following field and operator combinations are supported:

    • name: =
    • parent: =, :
    • resource_name: =, :
    • state: =, :
    • category: =, :
    • external_uri: =, :
    • event_time: =, >, <, >=, <=

    Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: event_time = "2019-06-10T16:07:18-07:00" event_time = 1560208038000

    • severity: =, :
    • security_marks.marks: =, :
    • resource:
      • resource.name: =, :
      • resource.parent_name: =, :
      • resource.parent_display_name: =, :
      • resource.project_name: =, :
      • resource.project_display_name: =, :
      • resource.type: =, :
  • group_by (::String) — Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name".
  • page_token (::String) — The value returned by the last GroupFindingsResponse; indicates that this is a continuation of a prior GroupFindings call, and that the system should return the next page of data.
  • page_size (::Integer) — The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::GroupFindingsRequest.new

# Call the group_findings method.
result = client.group_findings 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::SecurityCenter::V2::GroupResult.
  p item
end

#initialize

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

Create a new SecurityCenter client object.

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

# Create a client using a custom configuration
client = ::Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new do |config|
  config.timeout = 10.0
end

#list_attack_paths

def list_attack_paths(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::AttackPath>
def list_attack_paths(parent: nil, filter: nil, page_token: nil, page_size: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::AttackPath>

Lists the attack paths for a set of simulation results or valued resources and filter.

Overloads 
def list_attack_paths(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::AttackPath>
Pass arguments to list_attack_paths via a request object, either of type ListAttackPathsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::ListAttackPathsRequest, ::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_attack_paths(parent: nil, filter: nil, page_token: nil, page_size: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::AttackPath>
Pass arguments to list_attack_paths 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. Name of parent to list attack paths.

    Valid formats: "organizations/{organization}", "organizations/{organization}/simulations/{simulation}" "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}" "organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}"

  • filter (::String) —

    The filter expression that filters the attack path in the response. Supported fields:

    • valued_resources supports =
  • page_token (::String) — The value returned by the last ListAttackPathsResponse; indicates that this is a continuation of a prior ListAttackPaths call, and that the system should return the next page of data.
  • page_size (::Integer) — The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::ListAttackPathsRequest.new

# Call the list_attack_paths method.
result = client.list_attack_paths 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::SecurityCenter::V2::AttackPath.
  p item
end

#list_big_query_exports

def list_big_query_exports(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::BigQueryExport>
def list_big_query_exports(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::BigQueryExport>

Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.

Overloads 
def list_big_query_exports(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::BigQueryExport>
Pass arguments to list_big_query_exports via a request object, either of type ListBigQueryExportsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::ListBigQueryExportsRequest, ::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_big_query_exports(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::BigQueryExport>
Pass arguments to list_big_query_exports 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, which owns the collection of BigQuery exports. Its format is "organizations/[organization_id]/locations/[location_id]", "folders/[folder_id]/locations/[location_id]", or "projects/[project_id]/locations/[location_id]".
  • page_size (::Integer) — The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — A page token, received from a previous ListBigQueryExports call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBigQueryExports must match the call that provided the page token.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::ListBigQueryExportsRequest.new

# Call the list_big_query_exports method.
result = client.list_big_query_exports 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::SecurityCenter::V2::BigQueryExport.
  p item
end

#list_findings

def list_findings(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::ListFindingsResponse::ListFindingsResult>
def list_findings(parent: nil, filter: nil, order_by: nil, field_mask: nil, page_token: nil, page_size: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::ListFindingsResponse::ListFindingsResult>

Lists an organization or source's findings.

To list across all sources for a given location provide a - as the source id. If no location is specified, finding are assumed to be in global. The following list shows some examples:

  • /v2/organizations/{organization_id}/sources/-/findings + /v2/organizations/{organization_id}/sources/-/locations/{location_id}/findings
Overloads 
def list_findings(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::ListFindingsResponse::ListFindingsResult>
Pass arguments to list_findings via a request object, either of type ListFindingsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::ListFindingsRequest, ::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_findings(parent: nil, filter: nil, order_by: nil, field_mask: nil, page_token: nil, page_size: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::ListFindingsResponse::ListFindingsResult>
Pass arguments to list_findings 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. Name of the source the findings belong to. If no location is specified, the default is global. The following list shows some examples:

    • organizations/[organization_id]/sources/[source_id] + organizations/[organization_id]/sources/[source_id]/locations/[location_id]
    • folders/[folder_id]/sources/[source_id]
    • folders/[folder_id]/sources/[source_id]/locations/[location_id]
    • projects/[project_id]/sources/[source_id]
    • projects/[project_id]/sources/[source_id]/locations/[location_id]

    To list across all sources provide a source_id of -. The following list shows some examples:

    • organizations/{organization_id}/sources/-
    • organizations/{organization_id}/sources/-/locations/{location_id}
    • folders/{folder_id}/sources/-
    • folders/{folder_id}/sources/-locations/{location_id}
    • projects/{projects_id}/sources/-
    • projects/{projects_id}/sources/-/locations/{location_id}
  • filter (::String) —

    Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND.

    Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. Examples include:

    • name
    • security_marks.marks.marka

    The supported operators are:

    • = for all value types.
    • >, <, >=, <= for integer values.
    • :, meaning substring matching, for strings.

    The supported value types are:

    • string literals in quotes.
    • integer literals without quotes.
    • boolean literals true and false without quotes.

    The following field and operator combinations are supported:

    • name: =
    • parent: =, :
    • resource_name: =, :
    • state: =, :
    • category: =, :
    • external_uri: =, :
    • event_time: =, >, <, >=, <=

    Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: event_time = "2019-06-10T16:07:18-07:00" event_time = 1560208038000

    • severity: =, :
    • security_marks.marks: =, :
    • resource:
      • resource.name: =, :
      • resource.parent_name: =, :
      • resource.parent_display_name: =, :
      • resource.project_name: =, :
      • resource.project_display_name: =, :
      • resource.type: =, :
      • resource.folders.resource_folder: =, :
      • resource.display_name: =, :
  • order_by (::String) — Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,parent". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,parent". Redundant space characters in the syntax are insignificant. "name desc,parent" and " name desc , parent " are equivalent.

    The following fields are supported: name parent state category resource_name event_time security_marks.marks

  • field_mask (::Google::Protobuf::FieldMask, ::Hash) — A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
  • page_token (::String) — The value returned by the last ListFindingsResponse; indicates that this is a continuation of a prior ListFindings call, and that the system should return the next page of data.
  • page_size (::Integer) — The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::ListFindingsRequest.new

# Call the list_findings method.
result = client.list_findings 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::SecurityCenter::V2::ListFindingsResponse::ListFindingsResult.
  p item
end

#list_mute_configs

def list_mute_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::MuteConfig>
def list_mute_configs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::MuteConfig>

Lists mute configs. If no location is specified, default is global.

Overloads 
def list_mute_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::MuteConfig>
Pass arguments to list_mute_configs via a request object, either of type ListMuteConfigsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::ListMuteConfigsRequest, ::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_mute_configs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::MuteConfig>
Pass arguments to list_mute_configs 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, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]", "organizations/[organization_id]/locations/[location_id]", "folders/[folder_id]/locations/[location_id]", "projects/[project_id]/locations/[location_id]".
  • page_size (::Integer) — The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — A page token, received from a previous ListMuteConfigs call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListMuteConfigs must match the call that provided the page token.

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

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::ListMuteConfigsRequest.new

# Call the list_mute_configs method.
result = client.list_mute_configs 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::SecurityCenter::V2::MuteConfig.
  p item
end

#list_notification_configs

def list_notification_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::NotificationConfig>
def list_notification_configs(parent: nil, page_token: nil, page_size: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::NotificationConfig>

Lists notification configs.

Overloads 
def list_notification_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::NotificationConfig>
Pass arguments to list_notification_configs via a request object, either of type ListNotificationConfigsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::ListNotificationConfigsRequest, ::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_notification_configs(parent: nil, page_token: nil, page_size: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::NotificationConfig>
Pass arguments to list_notification_configs 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 name of the parent in which to list the notification configurations. Its format is "organizations/[organization_id]/locations/[location_id]", "folders/[folder_id]/locations/[location_id]", or "projects/[project_id]/locations/[location_id]".
  • page_token (::String) — The value returned by the last ListNotificationConfigsResponse; indicates that this is a continuation of a prior ListNotificationConfigs call, and that the system should return the next page of data.
  • page_size (::Integer) — The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::ListNotificationConfigsRequest.new

# Call the list_notification_configs method.
result = client.list_notification_configs 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::SecurityCenter::V2::NotificationConfig.
  p item
end

#list_resource_value_configs

def list_resource_value_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::ResourceValueConfig>
def list_resource_value_configs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::ResourceValueConfig>

Lists all ResourceValueConfigs.

Overloads 
def list_resource_value_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::ResourceValueConfig>
Pass arguments to list_resource_value_configs via a request object, either of type ListResourceValueConfigsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::ListResourceValueConfigsRequest, ::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_resource_value_configs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::ResourceValueConfig>
Pass arguments to list_resource_value_configs 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, which owns the collection of resource value configs. Its format is "organizations/[organization_id]"
  • page_size (::Integer) — The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — A page token, received from a previous ListResourceValueConfigs call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListResourceValueConfigs must match the call that provided the page token.

    page_size can be specified, and the new page_size will be used.

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

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::ListResourceValueConfigsRequest.new

# Call the list_resource_value_configs method.
result = client.list_resource_value_configs 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::SecurityCenter::V2::ResourceValueConfig.
  p item
end

#list_sources

def list_sources(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::Source>
def list_sources(parent: nil, page_token: nil, page_size: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::Source>

Lists all sources belonging to an organization.

Overloads 
def list_sources(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::Source>
Pass arguments to list_sources via a request object, either of type ListSourcesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::ListSourcesRequest, ::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_sources(parent: nil, page_token: nil, page_size: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::Source>
Pass arguments to list_sources 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. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".
  • page_token (::String) — The value returned by the last ListSourcesResponse; indicates that this is a continuation of a prior ListSources call, and that the system should return the next page of data.
  • page_size (::Integer) — The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::ListSourcesRequest.new

# Call the list_sources method.
result = client.list_sources 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::SecurityCenter::V2::Source.
  p item
end

#list_valued_resources

def list_valued_resources(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::ValuedResource>
def list_valued_resources(parent: nil, filter: nil, page_token: nil, page_size: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::ValuedResource>

Lists the valued resources for a set of simulation results and filter.

Overloads 
def list_valued_resources(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::ValuedResource>
Pass arguments to list_valued_resources via a request object, either of type ListValuedResourcesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::ListValuedResourcesRequest, ::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_valued_resources(parent: nil, filter: nil, page_token: nil, page_size: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenter::V2::ValuedResource>
Pass arguments to list_valued_resources 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. Name of parent to list exposed resources.

    Valid formats: "organizations/{organization}", "organizations/{organization}/simulations/{simulation}" "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}"

  • filter (::String) —

    The filter expression that filters the valued resources in the response. Supported fields:

    • resource_value supports =
    • resource_type supports =
  • page_token (::String) — The value returned by the last ListValuedResourcesResponse; indicates that this is a continuation of a prior ListValuedResources call, and that the system should return the next page of data.
  • page_size (::Integer) — The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
  • order_by (::String) — Optional. The fields by which to order the valued resources response.

    Supported fields:

    • exposed_score

    • resource_value

    • resource_type

    Values should be a comma separated list of fields. For example: exposed_score,resource_value.

    The default sorting order is descending. To specify ascending or descending order for a field, append a " ASC" or a " DESC" suffix, respectively; for example: exposed_score DESC.

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

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::ListValuedResourcesRequest.new

# Call the list_valued_resources method.
result = client.list_valued_resources 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::SecurityCenter::V2::ValuedResource.
  p item
end

#operations_client

def operations_client() -> ::Google::Cloud::SecurityCenter::V2::SecurityCenter::Operations

Get the associated client for long-running operations.

Returns

#set_finding_state

def set_finding_state(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Finding
def set_finding_state(name: nil, state: nil) -> ::Google::Cloud::SecurityCenter::V2::Finding

Updates the state of a finding. If no location is specified, finding is assumed to be in global

Overloads 
def set_finding_state(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Finding
Pass arguments to set_finding_state via a request object, either of type Google::Cloud::SecurityCenter::V2::SetFindingStateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::SetFindingStateRequest, ::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 set_finding_state(name: nil, state: nil) -> ::Google::Cloud::SecurityCenter::V2::Finding
Pass arguments to set_finding_state 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 relative resource name of the finding. If no location is specified, finding is assumed to be in global. The following list shows some examples:

    + organizations/{organization_id}/sources/{source_id}/findings/{finding_id} + organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}

    • folders/{folder_id}/sources/{source_id}/findings/{finding_id} + folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
    • projects/{project_id}/sources/{source_id}/findings/{finding_id} + projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
  • state (::Google::Cloud::SecurityCenter::V2::Finding::State) — Required. The desired State of the finding.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::SetFindingStateRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::Finding.
p result

#set_iam_policy

def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy

Sets the access control policy on the specified Source.

Overloads 
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::SetIamPolicyRequest, ::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 set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
Pass arguments to set_iam_policy 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
  • resource (::String) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

    paths: "bindings, etag"

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

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::SetIamPolicyRequest.new

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

# The returned object is of type Google::Iam::V1::Policy.
p result

#set_mute

def set_mute(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Finding
def set_mute(name: nil, mute: nil) -> ::Google::Cloud::SecurityCenter::V2::Finding

Updates the mute state of a finding. If no location is specified, finding is assumed to be in global

Overloads 
def set_mute(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Finding
Pass arguments to set_mute via a request object, either of type Google::Cloud::SecurityCenter::V2::SetMuteRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::SetMuteRequest, ::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 set_mute(name: nil, mute: nil) -> ::Google::Cloud::SecurityCenter::V2::Finding
Pass arguments to set_mute 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 relative resource name of the finding. If no location is specified, finding is assumed to be in global. The following list shows some examples:

    + organizations/{organization_id}/sources/{source_id}/findings/{finding_id} + organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}

    • folders/{folder_id}/sources/{source_id}/findings/{finding_id} + folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
    • projects/{project_id}/sources/{source_id}/findings/{finding_id} + projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
  • mute (::Google::Cloud::SecurityCenter::V2::Finding::Mute) — Required. The desired state of the Mute.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::SetMuteRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::Finding.
p result

#test_iam_permissions

def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

Returns the permissions that a caller has on the specified source.

Overloads 
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::TestIamPermissionsRequest, ::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 test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Pass arguments to test_iam_permissions 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
  • resource (::String) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • permissions (::Array<::String>) — The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::TestIamPermissionsRequest.new

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

# The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_big_query_export

def update_big_query_export(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::BigQueryExport
def update_big_query_export(big_query_export: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::BigQueryExport

Updates a BigQuery export.

Overloads 
def update_big_query_export(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::BigQueryExport
Pass arguments to update_big_query_export via a request object, either of type UpdateBigQueryExportRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::UpdateBigQueryExportRequest, ::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_big_query_export(big_query_export: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::BigQueryExport
Pass arguments to update_big_query_export 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
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::UpdateBigQueryExportRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::BigQueryExport.
p result

#update_external_system

def update_external_system(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::ExternalSystem
def update_external_system(external_system: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::ExternalSystem

Updates external system. This is for a given finding. If no location is specified, finding is assumed to be in global

Overloads 
def update_external_system(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::ExternalSystem
Pass arguments to update_external_system via a request object, either of type UpdateExternalSystemRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::UpdateExternalSystemRequest, ::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_external_system(external_system: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::ExternalSystem
Pass arguments to update_external_system 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
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::UpdateExternalSystemRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::ExternalSystem.
p result

#update_finding

def update_finding(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Finding
def update_finding(finding: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::Finding

Creates or updates a finding. If no location is specified, finding is assumed to be in global. The corresponding source must exist for a finding creation to succeed.

Overloads 
def update_finding(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Finding
Pass arguments to update_finding via a request object, either of type UpdateFindingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::UpdateFindingRequest, ::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_finding(finding: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::Finding
Pass arguments to update_finding 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
  • finding (::Google::Cloud::SecurityCenter::V2::Finding, ::Hash) — Required. The finding resource to update or create if it does not already exist. parent, security_marks, and update_time will be ignored.

    In the case of creation, the finding id portion of the name must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length.

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding.

    When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using "source_properties.

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

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::UpdateFindingRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::Finding.
p result

#update_mute_config

def update_mute_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig
def update_mute_config(mute_config: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig

Updates a mute config. If no location is specified, default is global.

Overloads 
def update_mute_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig
Pass arguments to update_mute_config via a request object, either of type UpdateMuteConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::UpdateMuteConfigRequest, ::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_mute_config(mute_config: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::MuteConfig
Pass arguments to update_mute_config 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
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::UpdateMuteConfigRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::MuteConfig.
p result

#update_notification_config

def update_notification_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::NotificationConfig
def update_notification_config(notification_config: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::NotificationConfig

Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter

Overloads 
def update_notification_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::NotificationConfig
Pass arguments to update_notification_config via a request object, either of type UpdateNotificationConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::UpdateNotificationConfigRequest, ::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_notification_config(notification_config: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::NotificationConfig
Pass arguments to update_notification_config 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
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::UpdateNotificationConfigRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::NotificationConfig.
p result

#update_resource_value_config

def update_resource_value_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::ResourceValueConfig
def update_resource_value_config(resource_value_config: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::ResourceValueConfig

Updates an existing ResourceValueConfigs with new rules.

Overloads 
def update_resource_value_config(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::ResourceValueConfig
Pass arguments to update_resource_value_config via a request object, either of type UpdateResourceValueConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::UpdateResourceValueConfigRequest, ::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_resource_value_config(resource_value_config: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::ResourceValueConfig
Pass arguments to update_resource_value_config 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
  • resource_value_config (::Google::Cloud::SecurityCenter::V2::ResourceValueConfig, ::Hash) — Required. The resource value config being updated.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to be updated. If empty all mutable fields will be updated.

    To update nested fields, include the top level field in the mask For example, to update gcp_metadata.resource_type, include the "gcp_metadata" field mask

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

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::UpdateResourceValueConfigRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::ResourceValueConfig.
p result

#update_security_marks

def update_security_marks(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::SecurityMarks
def update_security_marks(security_marks: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::SecurityMarks

Updates security marks. For Finding Security marks, if no location is specified, finding is assumed to be in global. Assets Security Marks can only be accessed through global endpoint.

Overloads 
def update_security_marks(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::SecurityMarks
Pass arguments to update_security_marks via a request object, either of type UpdateSecurityMarksRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::UpdateSecurityMarksRequest, ::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_security_marks(security_marks: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::SecurityMarks
Pass arguments to update_security_marks 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
  • security_marks (::Google::Cloud::SecurityCenter::V2::SecurityMarks, ::Hash) — Required. The security marks resource to update.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — The FieldMask to use when updating the security marks resource.

    The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.

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

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::UpdateSecurityMarksRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::SecurityMarks.
p result

#update_source

def update_source(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Source
def update_source(source: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::Source

Updates a source.

Overloads 
def update_source(request, options = nil) -> ::Google::Cloud::SecurityCenter::V2::Source
Pass arguments to update_source via a request object, either of type UpdateSourceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::SecurityCenter::V2::UpdateSourceRequest, ::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_source(source: nil, update_mask: nil) -> ::Google::Cloud::SecurityCenter::V2::Source
Pass arguments to update_source 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
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/security_center/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::SecurityCenter::V2::SecurityCenter::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecurityCenter::V2::UpdateSourceRequest.new

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

# The returned object is of type Google::Cloud::SecurityCenter::V2::Source.
p result