Class IamPolicyAnalysisQuery.Options (3.28.0) 

public static final class IamPolicyAnalysisQuery.Options extends GeneratedMessageV3 implements IamPolicyAnalysisQuery.OptionsOrBuilder

Contains query options.

Protobuf type google.cloud.asset.v1.IamPolicyAnalysisQuery.Options

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > IamPolicyAnalysisQuery.Options

Static Fields

ANALYZE_SERVICE_ACCOUNT_IMPERSONATION_FIELD_NUMBER

public static final int ANALYZE_SERVICE_ACCOUNT_IMPERSONATION_FIELD_NUMBER
Field Value
Type Description
int

EXPAND_GROUPS_FIELD_NUMBER

public static final int EXPAND_GROUPS_FIELD_NUMBER
Field Value
Type Description
int

EXPAND_RESOURCES_FIELD_NUMBER

public static final int EXPAND_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

EXPAND_ROLES_FIELD_NUMBER

public static final int EXPAND_ROLES_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_GROUP_EDGES_FIELD_NUMBER

public static final int OUTPUT_GROUP_EDGES_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_RESOURCE_EDGES_FIELD_NUMBER

public static final int OUTPUT_RESOURCE_EDGES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static IamPolicyAnalysisQuery.Options getDefaultInstance()
Returns
Type Description
IamPolicyAnalysisQuery.Options

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static IamPolicyAnalysisQuery.Options.Builder newBuilder()
Returns
Type Description
IamPolicyAnalysisQuery.Options.Builder

newBuilder(IamPolicyAnalysisQuery.Options prototype)

public static IamPolicyAnalysisQuery.Options.Builder newBuilder(IamPolicyAnalysisQuery.Options prototype)
Parameter
Name Description
prototype IamPolicyAnalysisQuery.Options
Returns
Type Description
IamPolicyAnalysisQuery.Options.Builder

parseDelimitedFrom(InputStream input)

public static IamPolicyAnalysisQuery.Options parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IamPolicyAnalysisQuery.Options
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IamPolicyAnalysisQuery.Options parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IamPolicyAnalysisQuery.Options
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static IamPolicyAnalysisQuery.Options parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
IamPolicyAnalysisQuery.Options
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IamPolicyAnalysisQuery.Options parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IamPolicyAnalysisQuery.Options
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IamPolicyAnalysisQuery.Options parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
IamPolicyAnalysisQuery.Options
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IamPolicyAnalysisQuery.Options parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IamPolicyAnalysisQuery.Options
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IamPolicyAnalysisQuery.Options parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
IamPolicyAnalysisQuery.Options
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IamPolicyAnalysisQuery.Options parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IamPolicyAnalysisQuery.Options
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static IamPolicyAnalysisQuery.Options parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IamPolicyAnalysisQuery.Options
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IamPolicyAnalysisQuery.Options parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IamPolicyAnalysisQuery.Options
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static IamPolicyAnalysisQuery.Options parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
IamPolicyAnalysisQuery.Options
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IamPolicyAnalysisQuery.Options parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IamPolicyAnalysisQuery.Options
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<IamPolicyAnalysisQuery.Options> parser()
Returns
Type Description
Parser<Options>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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.

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];

Returns
Type Description
boolean

The analyzeServiceAccountImpersonation.

getDefaultInstanceForType()

public IamPolicyAnalysisQuery.Options getDefaultInstanceForType()
Returns
Type Description
IamPolicyAnalysisQuery.Options

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 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];

Returns
Type Description
boolean

The expandGroups.

getExpandResources()

public boolean getExpandResources()

Optional. If true and 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 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];

Returns
Type Description
boolean

The expandResources.

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 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];

Returns
Type Description
boolean

The expandRoles.

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];

Returns
Type Description
boolean

The outputGroupEdges.

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];

Returns
Type Description
boolean

The outputResourceEdges.

getParserForType()

public Parser<IamPolicyAnalysisQuery.Options> getParserForType()
Returns
Type Description
Parser<Options>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public IamPolicyAnalysisQuery.Options.Builder newBuilderForType()
Returns
Type Description
IamPolicyAnalysisQuery.Options.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IamPolicyAnalysisQuery.Options.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
IamPolicyAnalysisQuery.Options.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public IamPolicyAnalysisQuery.Options.Builder toBuilder()
Returns
Type Description
IamPolicyAnalysisQuery.Options.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException