public final class SearchAllIamPoliciesRequest extends GeneratedMessageV3 implements SearchAllIamPoliciesRequestOrBuilder
Search all IAM policies request.
Protobuf type google.cloud.asset.v1.SearchAllIamPoliciesRequest
Static Fields
ASSET_TYPES_FIELD_NUMBER
public static final int ASSET_TYPES_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
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
Field Value
SCOPE_FIELD_NUMBER
public static final int SCOPE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SearchAllIamPoliciesRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SearchAllIamPoliciesRequest.Builder newBuilder()
Returns
newBuilder(SearchAllIamPoliciesRequest prototype)
public static SearchAllIamPoliciesRequest.Builder newBuilder(SearchAllIamPoliciesRequest prototype)
Parameter
Returns
public static SearchAllIamPoliciesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchAllIamPoliciesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SearchAllIamPoliciesRequest parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchAllIamPoliciesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SearchAllIamPoliciesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchAllIamPoliciesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchAllIamPoliciesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SearchAllIamPoliciesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchAllIamPoliciesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchAllIamPoliciesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SearchAllIamPoliciesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchAllIamPoliciesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SearchAllIamPoliciesRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAssetTypes(int index)
public String getAssetTypes(int index)
Optional. A list of asset types that the IAM policies are attached to. If empty, it
will search the IAM policies that are attached to all the searchable asset
types.
Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots IAM policies attached to asset type
starts with "compute.googleapis.com".
- ".*Instance" snapshots IAM policies attached to asset type ends with
"Instance".
- ".Instance." snapshots IAM policies attached to asset type contains
"Instance".
See RE2 for all supported
regular expression syntax. If the regular expression does not match any
supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 5 [(.google.api.field_behavior) = OPTIONAL];
| Name |
Description |
| index |
int
The index of the element to return.
|
Returns
| Type |
Description |
| String |
The assetTypes at the given index.
|
getAssetTypesBytes(int index)
public ByteString getAssetTypesBytes(int index)
Optional. A list of asset types that the IAM policies are attached to. If empty, it
will search the IAM policies that are attached to all the searchable asset
types.
Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots IAM policies attached to asset type
starts with "compute.googleapis.com".
- ".*Instance" snapshots IAM policies attached to asset type ends with
"Instance".
- ".Instance." snapshots IAM policies attached to asset type contains
"Instance".
See RE2 for all supported
regular expression syntax. If the regular expression does not match any
supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 5 [(.google.api.field_behavior) = OPTIONAL];
| Name |
Description |
| index |
int
The index of the value to return.
|
Returns
| Type |
Description |
| ByteString |
The bytes of the assetTypes at the given index.
|
getAssetTypesCount()
public int getAssetTypesCount()
Optional. A list of asset types that the IAM policies are attached to. If empty, it
will search the IAM policies that are attached to all the searchable asset
types.
Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots IAM policies attached to asset type
starts with "compute.googleapis.com".
- ".*Instance" snapshots IAM policies attached to asset type ends with
"Instance".
- ".Instance." snapshots IAM policies attached to asset type contains
"Instance".
See RE2 for all supported
regular expression syntax. If the regular expression does not match any
supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type |
Description |
| int |
The count of assetTypes.
|
getAssetTypesList()
public ProtocolStringList getAssetTypesList()
Optional. A list of asset types that the IAM policies are attached to. If empty, it
will search the IAM policies that are attached to all the searchable asset
types.
Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots IAM policies attached to asset type
starts with "compute.googleapis.com".
- ".*Instance" snapshots IAM policies attached to asset type ends with
"Instance".
- ".Instance." snapshots IAM policies attached to asset type contains
"Instance".
See RE2 for all supported
regular expression syntax. If the regular expression does not match any
supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 5 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public SearchAllIamPoliciesRequest getDefaultInstanceForType()
Returns
getOrderBy()
public String getOrderBy()
Optional. A comma-separated list of fields specifying the sorting order of the
results. The default order is ascending. Add " DESC" after the field name
to indicate descending order. Redundant space characters are ignored.
Example: "assetType DESC, resource".
Only singular primitive fields in the response are sortable:
- resource
- assetType
- project
All the other fields such as repeated fields (e.g.,
folders) and
non-primitive fields (e.g., policy) are not supported.
string order_by = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type |
Description |
| String |
The orderBy.
|
getOrderByBytes()
public ByteString getOrderByBytes()
Optional. A comma-separated list of fields specifying the sorting order of the
results. The default order is ascending. Add " DESC" after the field name
to indicate descending order. Redundant space characters are ignored.
Example: "assetType DESC, resource".
Only singular primitive fields in the response are sortable:
- resource
- assetType
- project
All the other fields such as repeated fields (e.g.,
folders) and
non-primitive fields (e.g., policy) are not supported.
string order_by = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type |
Description |
| ByteString |
The bytes for orderBy.
|
getPageSize()
Optional. The page size for search result pagination. Page size is capped at 500 even
if a larger value is given. If set to zero, server will pick an appropriate
default. Returned results may be fewer than requested. When this happens,
there could be more results as long as next_page_token is returned.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Type |
Description |
| int |
The pageSize.
|
getPageToken()
public String getPageToken()
Optional. If present, retrieve the next batch of results from the preceding call to
this method. page_token must be the value of next_page_token from the
previous response. The values of all other method parameters must be
identical to those in the previous call.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Type |
Description |
| String |
The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
Optional. If present, retrieve the next batch of results from the preceding call to
this method. page_token must be the value of next_page_token from the
previous response. The values of all other method parameters must be
identical to those in the previous call.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Type |
Description |
| ByteString |
The bytes for pageToken.
|
getParserForType()
public Parser<SearchAllIamPoliciesRequest> getParserForType()
Returns
Overrides
getQuery()
Optional. The query statement. See how to construct a
query
for more information. If not specified or empty, it will search all the
IAM policies within the specified scope. Note that the query string is
compared against each Cloud IAM policy binding, including its principals,
roles, and Cloud IAM conditions. The returned Cloud IAM policies will only
contain the bindings that match your query. To learn more about the IAM
policy structure, see the IAM policy
documentation.
Examples:
policy:amy@gmail.com to find IAM policy bindings that specify user
"amy@gmail.com".policy:roles/compute.admin to find IAM policy bindings that specify
the Compute Admin role.policy:comp* to find IAM policy bindings that contain "comp" as a
prefix of any word in the binding.policy.role.permissions:storage.buckets.update to find IAM policy
bindings that specify a role containing "storage.buckets.update"
permission. Note that if callers don't have iam.roles.get access to a
role's included permissions, policy bindings that specify this role will
be dropped from the search results.policy.role.permissions:upd* to find IAM policy bindings that specify a
role containing "upd" as a prefix of any word in the role permission.
Note that if callers don't have iam.roles.get access to a role's
included permissions, policy bindings that specify this role will be
dropped from the search results.resource:organizations/123456 to find IAM policy bindings
that are set on "organizations/123456".resource=//cloudresourcemanager.googleapis.com/projects/myproject to
find IAM policy bindings that are set on the project named "myproject".Important to find IAM policy bindings that contain "Important" as a
word in any of the searchable fields (except for the included
permissions).resource:(instance1 OR instance2) policy:amy to find
IAM policy bindings that are set on resources "instance1" or
"instance2" and also specify user "amy".roles:roles/compute.admin to find IAM policy bindings that specify the
Compute Admin role.memberTypes:user to find IAM policy bindings that contain the
principal type "user".
string query = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type |
Description |
| String |
The query.
|
getQueryBytes()
public ByteString getQueryBytes()
Optional. The query statement. See how to construct a
query
for more information. If not specified or empty, it will search all the
IAM policies within the specified scope. Note that the query string is
compared against each Cloud IAM policy binding, including its principals,
roles, and Cloud IAM conditions. The returned Cloud IAM policies will only
contain the bindings that match your query. To learn more about the IAM
policy structure, see the IAM policy
documentation.
Examples:
policy:amy@gmail.com to find IAM policy bindings that specify user
"amy@gmail.com".policy:roles/compute.admin to find IAM policy bindings that specify
the Compute Admin role.policy:comp* to find IAM policy bindings that contain "comp" as a
prefix of any word in the binding.policy.role.permissions:storage.buckets.update to find IAM policy
bindings that specify a role containing "storage.buckets.update"
permission. Note that if callers don't have iam.roles.get access to a
role's included permissions, policy bindings that specify this role will
be dropped from the search results.policy.role.permissions:upd* to find IAM policy bindings that specify a
role containing "upd" as a prefix of any word in the role permission.
Note that if callers don't have iam.roles.get access to a role's
included permissions, policy bindings that specify this role will be
dropped from the search results.resource:organizations/123456 to find IAM policy bindings
that are set on "organizations/123456".resource=//cloudresourcemanager.googleapis.com/projects/myproject to
find IAM policy bindings that are set on the project named "myproject".Important to find IAM policy bindings that contain "Important" as a
word in any of the searchable fields (except for the included
permissions).resource:(instance1 OR instance2) policy:amy to find
IAM policy bindings that are set on resources "instance1" or
"instance2" and also specify user "amy".roles:roles/compute.admin to find IAM policy bindings that specify the
Compute Admin role.memberTypes:user to find IAM policy bindings that contain the
principal type "user".
string query = 2 [(.google.api.field_behavior) = OPTIONAL];
getScope()
Required. A scope can be a project, a folder, or an organization. The search is
limited to the IAM policies within the scope. The caller must be granted
the
cloudasset.assets.searchAllIamPolicies
permission on the desired scope.
The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
string scope = 1 [(.google.api.field_behavior) = REQUIRED];
| Type |
Description |
| String |
The scope.
|
getScopeBytes()
public ByteString getScopeBytes()
Required. A scope can be a project, a folder, or an organization. The search is
limited to the IAM policies within the scope. The caller must be granted
the
cloudasset.assets.searchAllIamPolicies
permission on the desired scope.
The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
string scope = 1 [(.google.api.field_behavior) = REQUIRED];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SearchAllIamPoliciesRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchAllIamPoliciesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SearchAllIamPoliciesRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
