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

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

Request message for listing assets.

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

Namespace

Google \ Cloud \ SecurityCenter \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: organizations/[organization_id], folders/[folder_id], or projects/[project_id].
↳ filter string

Expression that defines the filter to apply across assets. 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 Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * 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 are the allowed field and operator combinations: * name: = * update_time: =, >, <, >=, <= Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: update_time = "2019-06-10T16:07:18-07:00" update_time = 1560208038000 * create_time: =, >, <, >=, <= Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: create_time = "2019-06-10T16:07:18-07:00" create_time = 1560208038000 * iam_policy.policy_blob: =, : * resource_properties: =, :, >, <, >=, <= * security_marks.marks: =, : * security_center_properties.resource_name: =, : * security_center_properties.resource_display_name: =, : * security_center_properties.resource_type: =, : * security_center_properties.resource_parent: =, : * security_center_properties.resource_parent_display_name: =, : * security_center_properties.resource_project: =, : * security_center_properties.resource_project_display_name: =, : * security_center_properties.resource_owners: =, : For example, resource_properties.size = 100 is a valid filter string. Use a partial match on the empty string to filter based on a property existing: resource_properties.my_property : "" Use a negated partial match on the empty string to filter based on a property not existing: -resource_properties.my_property : ""
↳ 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,resource_properties.a_property". 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,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type
↳ read_time Google\Protobuf\Timestamp

Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.
↳ compare_duration Google\Protobuf\Duration

When compare_duration is set, the ListAssetsResult's "state_change" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time.
↳ field_mask Google\Protobuf\FieldMask

A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.
↳ page_token string

The value returned by the last ListAssetsResponse; indicates that this is a continuation of a prior ListAssets 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. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: organizations/[organization_id], folders/[folder_id], or projects/[project_id].

Returns
Type Description
string

setParent

Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: organizations/[organization_id], folders/[folder_id], or projects/[project_id].

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Expression that defines the filter to apply across assets.

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 Asset resource. Examples include:

  • name
  • security_center_properties.resource_name
  • resource_properties.a_property
  • 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 are the allowed field and operator combinations:
  • name: =
  • update_time: =, >, <, >=, <= Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: update_time = "2019-06-10T16:07:18-07:00" update_time = 1560208038000
  • create_time: =, >, <, >=, <= Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: create_time = "2019-06-10T16:07:18-07:00" create_time = 1560208038000
  • iam_policy.policy_blob: =, :
  • resource_properties: =, :, >, <, >=, <=
  • security_marks.marks: =, :
  • security_center_properties.resource_name: =, :
  • security_center_properties.resource_display_name: =, :
  • security_center_properties.resource_type: =, :
  • security_center_properties.resource_parent: =, :
  • security_center_properties.resource_parent_display_name: =, :
  • security_center_properties.resource_project: =, :
  • security_center_properties.resource_project_display_name: =, :
  • security_center_properties.resource_owners: =, : For example, resource_properties.size = 100 is a valid filter string. Use a partial match on the empty string to filter based on a property existing: resource_properties.my_property : "" Use a negated partial match on the empty string to filter based on a property not existing: -resource_properties.my_property : ""
Returns
Type Description
string

setFilter

Expression that defines the filter to apply across assets.

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 Asset resource. Examples include:

  • name
  • security_center_properties.resource_name
  • resource_properties.a_property
  • 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 are the allowed field and operator combinations:
  • name: =
  • update_time: =, >, <, >=, <= Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: update_time = "2019-06-10T16:07:18-07:00" update_time = 1560208038000
  • create_time: =, >, <, >=, <= Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: create_time = "2019-06-10T16:07:18-07:00" create_time = 1560208038000
  • iam_policy.policy_blob: =, :
  • resource_properties: =, :, >, <, >=, <=
  • security_marks.marks: =, :
  • security_center_properties.resource_name: =, :
  • security_center_properties.resource_display_name: =, :
  • security_center_properties.resource_type: =, :
  • security_center_properties.resource_parent: =, :
  • security_center_properties.resource_parent_display_name: =, :
  • security_center_properties.resource_project: =, :
  • security_center_properties.resource_project_display_name: =, :
  • security_center_properties.resource_owners: =, : For example, resource_properties.size = 100 is a valid filter string. Use a partial match on the empty string to filter based on a property existing: resource_properties.my_property : "" Use a negated partial match on the empty string to filter based on a property not existing: -resource_properties.my_property : ""
Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

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,resource_properties.a_property". 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,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent.

The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type

Returns
Type Description
string

setOrderBy

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,resource_properties.a_property". 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,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent.

The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type

Parameter
Name Description
var string
Returns
Type Description
$this

getReadTime

Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasReadTime

clearReadTime

setReadTime

Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCompareDuration

When compare_duration is set, the ListAssetsResult's "state_change" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time.

The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified:

  • "ADDED": indicates that the asset was not present at the start of compare_duration, but present at read_time.
  • "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time.
  • "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time.
Returns
Type Description
Google\Protobuf\Duration|null

hasCompareDuration

clearCompareDuration

setCompareDuration

When compare_duration is set, the ListAssetsResult's "state_change" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time.

The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified:

  • "ADDED": indicates that the asset was not present at the start of compare_duration, but present at read_time.
  • "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time.
  • "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time.
Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getFieldMask

A field mask to specify the ListAssetsResult fields to be listed in the response.

An empty field mask will list all fields.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasFieldMask

clearFieldMask

setFieldMask

A field mask to specify the ListAssetsResult fields to be listed in the response.

An empty field mask will list all fields.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getPageToken

The value returned by the last ListAssetsResponse; indicates that this is a continuation of a prior ListAssets call, and that the system should return the next page of data.

Returns
Type Description
string

setPageToken

The value returned by the last ListAssetsResponse; indicates that this is a continuation of a prior ListAssets 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