public final class ListAssetsRequest extends GeneratedMessageV3 implements ListAssetsRequestOrBuilder
Request message for listing assets.
Protobuf type google.cloud.securitycenter.v1p1beta1.ListAssetsRequest
Fields
COMPARE_DURATION_FIELD_NUMBER
public static final int COMPARE_DURATION_FIELD_NUMBER
Field Value
FIELD_MASK_FIELD_NUMBER
public static final int FIELD_MASK_FIELD_NUMBER
Field Value
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCompareDuration()
public Duration 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.
.google.protobuf.Duration compare_duration = 5;
| Type | Description |
| Duration | The compareDuration.
|
getCompareDurationOrBuilder()
public DurationOrBuilder getCompareDurationOrBuilder()
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.
.google.protobuf.Duration compare_duration = 5;
getDefaultInstance()
public static ListAssetsRequest getDefaultInstance()
Returns
getDefaultInstanceForType()
public ListAssetsRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getFieldMask()
public FieldMask getFieldMask()
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;
getFieldMaskOrBuilder()
public FieldMaskOrBuilder getFieldMaskOrBuilder()
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;
getFilter()
public 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 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 : ""
string filter = 2;
| Type | Description |
| String | The filter.
|
getFilterBytes()
public 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 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 : ""
string filter = 2;
getOrderBy()
public 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.
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
string order_by = 3;
| Type | Description |
| String | The orderBy.
|
getOrderByBytes()
public 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.
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
string order_by = 3;
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;
| Type | Description |
| int | The pageSize.
|
getPageToken()
public 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;
| Type | Description |
| String | The pageToken.
|
getPageTokenBytes()
public 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;
getParent()
public String getParent()
Required. Name of the organization assets should belong to. Its format is
"organizations/[organization_id], folders/[folder_id], or
projects/[project_id]".
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. Name of the organization assets should belong to. Its format is
"organizations/[organization_id], folders/[folder_id], or
projects/[project_id]".
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParserForType()
public Parser<ListAssetsRequest> getParserForType()
Returns
Overrides
getReadTime()
public 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;
getReadTimeOrBuilder()
public 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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasCompareDuration()
public boolean hasCompareDuration()
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.
.google.protobuf.Duration compare_duration = 5;
| Type | Description |
| boolean | Whether the compareDuration field is set.
|
hasFieldMask()
public boolean hasFieldMask()
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;
| Type | Description |
| boolean | Whether the fieldMask field is set.
|
hasReadTime()
public 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;
| Type | Description |
| boolean | Whether the readTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static ListAssetsRequest.Builder newBuilder()
Returns
newBuilder(ListAssetsRequest prototype)
public static ListAssetsRequest.Builder newBuilder(ListAssetsRequest prototype)
Parameter
Returns
newBuilderForType()
public ListAssetsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListAssetsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static ListAssetsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListAssetsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListAssetsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListAssetsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListAssetsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListAssetsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListAssetsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListAssetsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListAssetsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListAssetsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListAssetsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListAssetsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListAssetsRequest> parser()
Returns
toBuilder()
public ListAssetsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
