Package com.google.cloud.asset.v1

Class IamPolicyAnalysisQuery.Options

    • Field Detail

      • EXPAND_GROUPS_FIELD_NUMBER

        public static final int EXPAND_GROUPS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPAND_ROLES_FIELD_NUMBER

        public static final int EXPAND_ROLES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPAND_RESOURCES_FIELD_NUMBER

        public static final int EXPAND_RESOURCES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OUTPUT_RESOURCE_EDGES_FIELD_NUMBER

        public static final int OUTPUT_RESOURCE_EDGES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OUTPUT_GROUP_EDGES_FIELD_NUMBER

        public static final int OUTPUT_GROUP_EDGES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ANALYZE_SERVICE_ACCOUNT_IMPERSONATION_FIELD_NUMBER

        public static final int ANALYZE_SERVICE_ACCOUNT_IMPERSONATION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getExpandGroups

        public boolean getExpandGroups()
         Optional. If true, the identities section of the result will expand any
 Google groups appearing in an IAM policy binding.

 If
 [IamPolicyAnalysisQuery.identity_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.identity_selector]
 is specified, the identity in the result will be determined by the
 selector, and this flag is not allowed to set.

 If true, the default max expansion per group is 1000 for
 AssetService.AnalyzeIamPolicy][].

 Default is false.
        bool expand_groups = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getExpandGroups in interface IamPolicyAnalysisQuery.OptionsOrBuilder
        Returns:
        The expandGroups.

      • getExpandRoles

        public boolean getExpandRoles()
         Optional. If true, the access section of result will expand any roles
 appearing in IAM policy bindings to include their permissions.

 If
 [IamPolicyAnalysisQuery.access_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.access_selector]
 is specified, the access section of the result will be determined by the
 selector, and this flag is not allowed to set.

 Default is false.
        bool expand_roles = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getExpandRoles in interface IamPolicyAnalysisQuery.OptionsOrBuilder
        Returns:
        The expandRoles.

      • getExpandResources

        public boolean getExpandResources()
         Optional. If true and
 [IamPolicyAnalysisQuery.resource_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.resource_selector]
 is not specified, the resource section of the result will expand any
 resource attached to an IAM policy to include resources lower in the
 resource hierarchy.

 For example, if the request analyzes for which resources user A has
 permission P, and the results include an IAM policy with P on a Google
 Cloud folder, the results will also include resources in that folder with
 permission P.

 If true and
 [IamPolicyAnalysisQuery.resource_selector][google.cloud.asset.v1.IamPolicyAnalysisQuery.resource_selector]
 is specified, the resource section of the result will expand the
 specified resource to include resources lower in the resource hierarchy.
 Only project or lower resources are supported. Folder and organization
 resources cannot be used together with this option.

 For example, if the request analyzes for which users have permission P on
 a Google Cloud project with this option enabled, the results will include
 all users who have permission P on that project or any lower resource.

 If true, the default max expansion per resource is 1000 for
 AssetService.AnalyzeIamPolicy][] and 100000 for
 AssetService.AnalyzeIamPolicyLongrunning][].

 Default is false.
        bool expand_resources = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getExpandResources in interface IamPolicyAnalysisQuery.OptionsOrBuilder
        Returns:
        The expandResources.

      • getOutputResourceEdges

        public boolean getOutputResourceEdges()
         Optional. If true, the result will output the relevant parent/child
 relationships between resources. Default is false.
        bool output_resource_edges = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOutputResourceEdges in interface IamPolicyAnalysisQuery.OptionsOrBuilder
        Returns:
        The outputResourceEdges.

      • getOutputGroupEdges

        public boolean getOutputGroupEdges()
         Optional. If true, the result will output the relevant membership
 relationships between groups and other groups, and between groups and
 principals. Default is false.
        bool output_group_edges = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOutputGroupEdges in interface IamPolicyAnalysisQuery.OptionsOrBuilder
        Returns:
        The outputGroupEdges.

      • getAnalyzeServiceAccountImpersonation

        public boolean getAnalyzeServiceAccountImpersonation()
         Optional. If true, the response will include access analysis from
 identities to resources via service account impersonation. This is a very
 expensive operation, because many derived queries will be executed. We
 highly recommend you use
 [AssetService.AnalyzeIamPolicyLongrunning][google.cloud.asset.v1.AssetService.AnalyzeIamPolicyLongrunning]
 RPC instead.

 For example, if the request analyzes for which resources user A has
 permission P, and there's an IAM policy states user A has
 iam.serviceAccounts.getAccessToken permission to a service account SA,
 and there's another IAM policy states service account SA has permission P
 to a Google Cloud folder F, then user A potentially has access to the
 Google Cloud folder F. And those advanced analysis results will be
 included in
 [AnalyzeIamPolicyResponse.service_account_impersonation_analysis][google.cloud.asset.v1.AnalyzeIamPolicyResponse.service_account_impersonation_analysis].

 Another example, if the request analyzes for who has
 permission P to a Google Cloud folder F, and there's an IAM policy states
 user A has iam.serviceAccounts.actAs permission to a service account SA,
 and there's another IAM policy states service account SA has permission P
 to the Google Cloud folder F, then user A potentially has access to the
 Google Cloud folder F. And those advanced analysis results will be
 included in
 [AnalyzeIamPolicyResponse.service_account_impersonation_analysis][google.cloud.asset.v1.AnalyzeIamPolicyResponse.service_account_impersonation_analysis].

 Only the following permissions are considered in this analysis:

 * `iam.serviceAccounts.actAs`
 * `iam.serviceAccounts.signBlob`
 * `iam.serviceAccounts.signJwt`
 * `iam.serviceAccounts.getAccessToken`
 * `iam.serviceAccounts.getOpenIdToken`
 * `iam.serviceAccounts.implicitDelegation`

 Default is false.
        bool analyze_service_account_impersonation = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAnalyzeServiceAccountImpersonation in interface IamPolicyAnalysisQuery.OptionsOrBuilder
        Returns:
        The analyzeServiceAccountImpersonation.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 IamPolicyAnalysisQuery.Options parseFrom​(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static IamPolicyAnalysisQuery.Options parseFrom​(com.google.protobuf.ByteString data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected IamPolicyAnalysisQuery.Options.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<IamPolicyAnalysisQuery.Options> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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