Chronicle V1 API - Class Google::Cloud::Chronicle::V1::FindingsRefinementService::Client (v0.9.0)

Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::FindingsRefinementService::Client.

Client for the FindingsRefinementService service.

FindingsRefinementService provides an interface for filtering out findings that are unlikely to be real threats to prevent them from triggering alerts or notifications.

Inherits

  • Object

Includes

Methods

.configure

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

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

#compute_all_findings_refinement_activities

def compute_all_findings_refinement_activities(request, options = nil) -> ::Google::Cloud::Chronicle::V1::ComputeAllFindingsRefinementActivitiesResponse
def compute_all_findings_refinement_activities(instance: nil, interval: nil) -> ::Google::Cloud::Chronicle::V1::ComputeAllFindingsRefinementActivitiesResponse

Returns findings refinement activity for all findings refinements.

Overloads 
def compute_all_findings_refinement_activities(request, options = nil) -> ::Google::Cloud::Chronicle::V1::ComputeAllFindingsRefinementActivitiesResponse
Pass arguments to compute_all_findings_refinement_activities via a request object, either of type ComputeAllFindingsRefinementActivitiesRequest or an equivalent Hash.
Parameters 
def compute_all_findings_refinement_activities(instance: nil, interval: nil) -> ::Google::Cloud::Chronicle::V1::ComputeAllFindingsRefinementActivitiesResponse
Pass arguments to compute_all_findings_refinement_activities 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
  • instance (::String) — Required. The ID of the Instance to retrieve counts for. Format: projects/{project}/locations/{location}/instances/{instance}
  • interval (::Google::Type::Interval, ::Hash) — The time interval the activity is measured over.
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/chronicle/v1"

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

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

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

# The returned object is of type Google::Cloud::Chronicle::V1::ComputeAllFindingsRefinementActivitiesResponse.
p result

#compute_findings_refinement_activity

def compute_findings_refinement_activity(request, options = nil) -> ::Google::Cloud::Chronicle::V1::ComputeFindingsRefinementActivityResponse
def compute_findings_refinement_activity(name: nil, interval: nil) -> ::Google::Cloud::Chronicle::V1::ComputeFindingsRefinementActivityResponse

Returns findings refinement activity for a specific findings refinement.

Overloads 
def compute_findings_refinement_activity(request, options = nil) -> ::Google::Cloud::Chronicle::V1::ComputeFindingsRefinementActivityResponse
Pass arguments to compute_findings_refinement_activity via a request object, either of type ComputeFindingsRefinementActivityRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::ComputeFindingsRefinementActivityRequest, ::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 compute_findings_refinement_activity(name: nil, interval: nil) -> ::Google::Cloud::Chronicle::V1::ComputeFindingsRefinementActivityResponse
Pass arguments to compute_findings_refinement_activity 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. Full resource name for the findings refinement to fetch the activity for. Format: projects/{project}/locations/{region}/instances/{instance}/findingsRefinements/{findings_refinement}
  • interval (::Google::Type::Interval, ::Hash) — The time interval the activity is measured over.
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/chronicle/v1"

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

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

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

# The returned object is of type Google::Cloud::Chronicle::V1::ComputeFindingsRefinementActivityResponse.
p result

#configure

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

Configure the FindingsRefinementService 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_findings_refinement

def create_findings_refinement(request, options = nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinement
def create_findings_refinement(parent: nil, findings_refinement: nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinement

Creates a new findings refinement.

Overloads 
def create_findings_refinement(request, options = nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinement
Pass arguments to create_findings_refinement via a request object, either of type CreateFindingsRefinementRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::CreateFindingsRefinementRequest, ::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_findings_refinement(parent: nil, findings_refinement: nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinement
Pass arguments to create_findings_refinement via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource where this findings refinement will be created. Format: projects/{project}/locations/{location}/instances/{instance}
  • findings_refinement (::Google::Cloud::Chronicle::V1::FindingsRefinement, ::Hash) — Required. The findings refinement to create.
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/chronicle/v1"

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

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

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

# The returned object is of type Google::Cloud::Chronicle::V1::FindingsRefinement.
p result

#get_findings_refinement

def get_findings_refinement(request, options = nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinement
def get_findings_refinement(name: nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinement

Gets a single findings refinement.

Overloads 
def get_findings_refinement(request, options = nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinement
Pass arguments to get_findings_refinement via a request object, either of type GetFindingsRefinementRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::GetFindingsRefinementRequest, ::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_findings_refinement(name: nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinement
Pass arguments to get_findings_refinement 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 findings refinement to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement}
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/chronicle/v1"

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

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

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

# The returned object is of type Google::Cloud::Chronicle::V1::FindingsRefinement.
p result

#get_findings_refinement_deployment

def get_findings_refinement_deployment(request, options = nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinementDeployment
def get_findings_refinement_deployment(name: nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinementDeployment

Gets a findings refinement deployment.

Overloads 
def get_findings_refinement_deployment(request, options = nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinementDeployment
Pass arguments to get_findings_refinement_deployment via a request object, either of type GetFindingsRefinementDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::GetFindingsRefinementDeploymentRequest, ::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_findings_refinement_deployment(name: nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinementDeployment
Pass arguments to get_findings_refinement_deployment 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 findings refinement to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement}/deployment
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/chronicle/v1"

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

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

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

# The returned object is of type Google::Cloud::Chronicle::V1::FindingsRefinementDeployment.
p result

#initialize

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

Create a new FindingsRefinementService client object.

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

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

#list_all_findings_refinement_deployments

def list_all_findings_refinement_deployments(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Chronicle::V1::FindingsRefinementDeployment>
def list_all_findings_refinement_deployments(instance: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Chronicle::V1::FindingsRefinementDeployment>

Lists all findings refinement deployments.

Overloads 
def list_all_findings_refinement_deployments(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Chronicle::V1::FindingsRefinementDeployment>
Pass arguments to list_all_findings_refinement_deployments via a request object, either of type ListAllFindingsRefinementDeploymentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::ListAllFindingsRefinementDeploymentsRequest, ::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_all_findings_refinement_deployments(instance: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Chronicle::V1::FindingsRefinementDeployment>
Pass arguments to list_all_findings_refinement_deployments 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
  • instance (::String) — Required. The name of the parent resource, which is the SecOps instance to list all findings refinement deployments over. Format: projects/{project}/locations/{location}/instances/{instance}
  • page_size (::Integer) — The maximum number of findings refinement deployments to return. The service may return fewer than this value. If unspecified, at most 100 rule deployments 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 ListAllFindingsRefinementDeployments call. Provide this to retrieve the subsequent page.

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

  • filter (::String) — A filter that can be used to retrieve specific findings refinement deployments. Only the following filters are allowed: detection_exclusion_application.curated_rule_sets:"
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/chronicle/v1"

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

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

# Call the list_all_findings_refinement_deployments method.
result = client.list_all_findings_refinement_deployments 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::Chronicle::V1::FindingsRefinementDeployment.
  p item
end

#list_findings_refinements

def list_findings_refinements(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Chronicle::V1::FindingsRefinement>
def list_findings_refinements(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Chronicle::V1::FindingsRefinement>

Lists a collection of findings refinements.

Overloads 
def list_findings_refinements(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Chronicle::V1::FindingsRefinement>
Pass arguments to list_findings_refinements via a request object, either of type ListFindingsRefinementsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::ListFindingsRefinementsRequest, ::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_refinements(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Chronicle::V1::FindingsRefinement>
Pass arguments to list_findings_refinements 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 this collection of findings refinements. Format: projects/{project}/locations/{location}/instances/{instance}
  • page_size (::Integer) — The maximum number of findings refinements to return. The service may return fewer than this value. If unspecified, at most 100 rules 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 ListFindingsRefinements call. Provide this to retrieve the subsequent page.
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/chronicle/v1"

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

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

# Call the list_findings_refinements method.
result = client.list_findings_refinements 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::Chronicle::V1::FindingsRefinement.
  p item
end

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_findings_refinement

def update_findings_refinement(request, options = nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinement
def update_findings_refinement(findings_refinement: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinement

Updates a findings refinement.

Overloads 
def update_findings_refinement(request, options = nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinement
Pass arguments to update_findings_refinement via a request object, either of type UpdateFindingsRefinementRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::UpdateFindingsRefinementRequest, ::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_findings_refinement(findings_refinement: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinement
Pass arguments to update_findings_refinement 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
  • findings_refinement (::Google::Cloud::Chronicle::V1::FindingsRefinement, ::Hash) — Required. The findings refinement to update.

    The findings refinement's name field is used to identify the findings refinement to update. Format: projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement}

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The list of fields to update. If * is provided, all fields will be updated.
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/chronicle/v1"

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

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

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

# The returned object is of type Google::Cloud::Chronicle::V1::FindingsRefinement.
p result

#update_findings_refinement_deployment

def update_findings_refinement_deployment(request, options = nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinementDeployment
def update_findings_refinement_deployment(findings_refinement_deployment: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinementDeployment

Updates a findings refinement deployment.

Overloads 
def update_findings_refinement_deployment(request, options = nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinementDeployment
Pass arguments to update_findings_refinement_deployment via a request object, either of type UpdateFindingsRefinementDeploymentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::UpdateFindingsRefinementDeploymentRequest, ::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_findings_refinement_deployment(findings_refinement_deployment: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::FindingsRefinementDeployment
Pass arguments to update_findings_refinement_deployment 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
  • findings_refinement_deployment (::Google::Cloud::Chronicle::V1::FindingsRefinementDeployment, ::Hash) — Required. The findings refinement deployment to update.

    The findings refinement deployment's name field is used to identify the findings refinement deployment to update. Format: projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement}/deployment

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The list of fields to update. If * is provided, all fields will be updated.
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/chronicle/v1"

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

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

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

# The returned object is of type Google::Cloud::Chronicle::V1::FindingsRefinementDeployment.
p result