Google Cloud Security Command Center V1 Client - Class ListValuedResourcesRequest (2.0.1)

Reference documentation and code samples for the Google Cloud Security Command Center V1 Client class ListValuedResourcesRequest.

Request message for listing the valued resources for a given simulation.

Generated from protobuf message google.cloud.securitycenter.v1.ListValuedResourcesRequest

Namespace

Google \ Cloud \ SecurityCenter \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. Name of parent to list valued 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 int

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 * resource * display_name 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.

getParent

Required. Name of parent to list valued resources.

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

Returns
Type Description
string

setParent

Required. Name of parent to list valued resources.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

The filter expression that filters the valued resources in the response.

Supported fields:

  • resource_value supports =
  • resource_type supports =
Returns
Type Description
string

setFilter

The filter expression that filters the valued resources in the response.

Supported fields:

  • resource_value supports =
  • resource_type supports =
Parameter
Name Description
var string
Returns
Type Description
$this

getPageToken

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.

Returns
Type Description
string

setPageToken

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.

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

getOrderBy

Optional. The fields by which to order the valued resources response.

Supported fields:

  • exposed_score
  • resource_value
  • resource_type
  • resource
  • display_name 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.
Returns
Type Description
string

setOrderBy

Optional. The fields by which to order the valued resources response.

Supported fields:

  • exposed_score
  • resource_value
  • resource_type
  • resource
  • display_name 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.
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Name of parent to list valued resources.

Valid formats: organizations/{organization}, organizations/{organization}/simulations/{simulation} organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2} Please see Google\Cloud\SecurityCenter\V1\SecurityCenterClient::simulationName() for help formatting this field.
Returns
Type Description
Google\Cloud\SecurityCenter\V1\ListValuedResourcesRequest