Package com.google.cloud.asset.v1

Class SearchAllIamPoliciesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.asset.v1.SearchAllIamPoliciesRequest
All Implemented Interfaces:
SearchAllIamPoliciesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchAllIamPoliciesRequest extends com.google.protobuf.GeneratedMessage implements SearchAllIamPoliciesRequestOrBuilder
 Search all IAM policies request.
Protobuf type google.cloud.asset.v1.SearchAllIamPoliciesRequest
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getScope

      public String 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`](https://cloud.google.com/asset-inventory/docs/access-control#required_permissions)
 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];
      Specified by:
      getScope in interface SearchAllIamPoliciesRequestOrBuilder
      Returns:
      The scope.

    • getScopeBytes

      public com.google.protobuf.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`](https://cloud.google.com/asset-inventory/docs/access-control#required_permissions)
 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];
      Specified by:
      getScopeBytes in interface SearchAllIamPoliciesRequestOrBuilder
      Returns:
      The bytes for scope.

    • getQuery

      public String getQuery()
       Optional. The query statement. See [how to construct a
 query](https://cloud.google.com/asset-inventory/docs/searching-iam-policies#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 IAM policy binding, including its principals,
 roles, and IAM conditions. The returned IAM policies will only
 contain the bindings that match your query. To learn more about the IAM
 policy structure, see the [IAM policy
 documentation](https://cloud.google.com/iam/help/allow-policies/structure).

 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];
      Specified by:
      getQuery in interface SearchAllIamPoliciesRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       Optional. The query statement. See [how to construct a
 query](https://cloud.google.com/asset-inventory/docs/searching-iam-policies#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 IAM policy binding, including its principals,
 roles, and IAM conditions. The returned IAM policies will only
 contain the bindings that match your query. To learn more about the IAM
 policy structure, see the [IAM policy
 documentation](https://cloud.google.com/iam/help/allow-policies/structure).

 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];
      Specified by:
      getQueryBytes in interface SearchAllIamPoliciesRequestOrBuilder
      Returns:
      The bytes for query.

    • getPageSize

      public int 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 or a negative value,
 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];
      Specified by:
      getPageSize in interface SearchAllIamPoliciesRequestOrBuilder
      Returns:
      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];
      Specified by:
      getPageToken in interface SearchAllIamPoliciesRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.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];
      Specified by:
      getPageTokenBytes in interface SearchAllIamPoliciesRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getAssetTypesList

      public com.google.protobuf.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 asset
 types [supported by search
 APIs](https://cloud.google.com/asset-inventory/docs/supported-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](https://github.com/google/re2/wiki/Syntax) 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];
      Specified by:
      getAssetTypesList in interface SearchAllIamPoliciesRequestOrBuilder
      Returns:
      A list containing the assetTypes.

    • 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 asset
 types [supported by search
 APIs](https://cloud.google.com/asset-inventory/docs/supported-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](https://github.com/google/re2/wiki/Syntax) 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];
      Specified by:
      getAssetTypesCount in interface SearchAllIamPoliciesRequestOrBuilder
      Returns:
      The count of assetTypes.

    • getAssetTypes

      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 asset
 types [supported by search
 APIs](https://cloud.google.com/asset-inventory/docs/supported-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](https://github.com/google/re2/wiki/Syntax) 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];
      Specified by:
      getAssetTypes in interface SearchAllIamPoliciesRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The assetTypes at the given index.

    • getAssetTypesBytes

      public com.google.protobuf.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 asset
 types [supported by search
 APIs](https://cloud.google.com/asset-inventory/docs/supported-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](https://github.com/google/re2/wiki/Syntax) 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];
      Specified by:
      getAssetTypesBytes in interface SearchAllIamPoliciesRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the assetTypes at the given index.

    • 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];
      Specified by:
      getOrderBy in interface SearchAllIamPoliciesRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public com.google.protobuf.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];
      Specified by:
      getOrderByBytes in interface SearchAllIamPoliciesRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SearchAllIamPoliciesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchAllIamPoliciesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchAllIamPoliciesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchAllIamPoliciesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchAllIamPoliciesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchAllIamPoliciesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchAllIamPoliciesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchAllIamPoliciesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchAllIamPoliciesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchAllIamPoliciesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchAllIamPoliciesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchAllIamPoliciesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SearchAllIamPoliciesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SearchAllIamPoliciesRequest.Builder newBuilder()

    • newBuilder

      public static SearchAllIamPoliciesRequest.Builder newBuilder(SearchAllIamPoliciesRequest prototype)

    • toBuilder

      public SearchAllIamPoliciesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SearchAllIamPoliciesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchAllIamPoliciesRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchAllIamPoliciesRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchAllIamPoliciesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SearchAllIamPoliciesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder