Interface ListAssetsRequestOrBuilder (2.40.0)

Version 2.40.0

• 2.63.0 (latest)
• 2.62.0
• 2.61.0
• 2.60.0
• 2.59.0
• 2.57.0
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.1
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.1
• 2.6.0
• 2.5.6
• 2.3.2

public interface ListAssetsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCompareDuration()

public abstract Duration getCompareDuration()

When compare_duration is set, the ListAssetResult's "state" 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 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" values when compare_duration is specified:

• "ADDED": indicates that the asset was not present before 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 is "UNUSED", which indicates that the asset is present at read_time.

.google.protobuf.Duration compare_duration = 5;

Returns
Type	Description
Duration	The compareDuration.

getCompareDurationOrBuilder()

public abstract DurationOrBuilder getCompareDurationOrBuilder()

When compare_duration is set, the ListAssetResult's "state" 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 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" values when compare_duration is specified:

• "ADDED": indicates that the asset was not present before 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 is "UNUSED", which indicates that the asset is present at read_time.

.google.protobuf.Duration compare_duration = 5;

Returns
Type	Description
DurationOrBuilder

getFieldMask()

public abstract FieldMask getFieldMask()

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

.google.protobuf.FieldMask field_mask = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
FieldMask	The fieldMask.

getFieldMaskOrBuilder()

public abstract FieldMaskOrBuilder getFieldMaskOrBuilder()

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

.google.protobuf.FieldMask field_mask = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
FieldMaskOrBuilder

getFilter()

public abstract String 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 not 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.

  For example, resource_properties.size = 100 is a valid filter string.

string filter = 2;

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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 not 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.

  For example, resource_properties.size = 100 is a valid filter string.

string filter = 2;

Returns
Type	Description
ByteString	The bytes for filter.

getOrderBy()

public abstract String 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.

string order_by = 3;

Returns
Type	Description
String	The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

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.

string order_by = 3;

Returns
Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

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

int32 page_size = 9;

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String 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.

string page_token = 8;

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 8;

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public abstract String getParent()

Required. Name of the organization assets should belong to. Its format is "organizations/[organization_id]".

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. Name of the organization assets should belong to. Its format is "organizations/[organization_id]".

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.

getReadTime()

public abstract Timestamp 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.

.google.protobuf.Timestamp read_time = 4;

Returns
Type	Description
Timestamp	The readTime.

getReadTimeOrBuilder()

public abstract TimestampOrBuilder getReadTimeOrBuilder()

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.

.google.protobuf.Timestamp read_time = 4;

Returns
Type	Description
TimestampOrBuilder

hasCompareDuration()

public abstract boolean hasCompareDuration()

When compare_duration is set, the ListAssetResult's "state" 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 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" values when compare_duration is specified:

• "ADDED": indicates that the asset was not present before 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 is "UNUSED", which indicates that the asset is present at read_time.

.google.protobuf.Duration compare_duration = 5;

Returns
Type	Description
boolean	Whether the compareDuration field is set.

hasFieldMask()

public abstract boolean hasFieldMask()

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

.google.protobuf.FieldMask field_mask = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the fieldMask field is set.

hasReadTime()

public abstract boolean hasReadTime()

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.

.google.protobuf.Timestamp read_time = 4;

Returns
Type	Description
boolean	Whether the readTime field is set.