Google Cloud Security Command Center V2 Client - Class ListAttackPathsRequest (1.30.0)

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

Request message for listing the attack paths for a given simulation or valued resource.

Generated from protobuf message google.cloud.securitycenter.v2.ListAttackPathsRequest

Namespace

Google \ Cloud \ SecurityCenter \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ 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`	`int` The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

getParent

Required. Name of parent to list attack paths.

Returns
Type	Description
`string`

setParent

Required. Name of parent to list attack paths.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

The filter expression that filters the attack path in the response.

Supported fields:

valued_resources supports =

Returns
Type	Description
`string`

setFilter

The filter expression that filters the attack path in the response.

Supported fields:

valued_resources supports =

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageToken

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.

Returns
Type	Description
`string`

setPageToken

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

Returns
Type	Description
`int`

setPageSize

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

static::build

Parameter

Name Description

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}" Please see Google\Cloud\SecurityCenter\V2\SecurityCenterClient::organizationValuedResourceName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\SecurityCenter\V2\ListAttackPathsRequest`