Google Cloud Chronicle V1 Client - Class ListAllFindingsRefinementDeploymentsRequest (0.5.0)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class ListAllFindingsRefinementDeploymentsRequest.

Request message for ListAllFindingsRefinementDeployments method.

Generated from protobuf message google.cloud.chronicle.v1.ListAllFindingsRefinementDeploymentsRequest

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ 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 int

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:"<curated_rule_set_name>"", detection_exclusion_application.curated_rules:"<curated_rule_name>"

getInstance

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}

Returns
Type Description
string

setInstance

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}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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.

Returns
Type Description
int

setPageSize

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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.

Returns
Type Description
string

setPageToken

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

A filter that can be used to retrieve specific findings refinement deployments.

Only the following filters are allowed: detection_exclusion_application.curated_rule_sets:"<curated_rule_set_name>"", detection_exclusion_application.curated_rules:"<curated_rule_name>"

Returns
Type Description
string

setFilter

A filter that can be used to retrieve specific findings refinement deployments.

Only the following filters are allowed: detection_exclusion_application.curated_rule_sets:"<curated_rule_set_name>"", detection_exclusion_application.curated_rules:"<curated_rule_name>"

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
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} Please see FindingsRefinementServiceClient::instanceName() for help formatting this field.

Returns
Type Description
ListAllFindingsRefinementDeploymentsRequest