com.google.cloud.asset.v1

Class IamPolicyAnalysisQuery.Options

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.asset.v1.IamPolicyAnalysisQuery.Options

All Implemented Interfaces:

IamPolicyAnalysisQuery.OptionsOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

Enclosing class:

IamPolicyAnalysisQuery

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

 Contains query options.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IamPolicyAnalysisQuery.Options.Builder Contains query options.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANALYZE_SERVICE_ACCOUNT_IMPERSONATION_FIELD_NUMBER
static int	EXPAND_GROUPS_FIELD_NUMBER
static int	EXPAND_RESOURCES_FIELD_NUMBER
static int	EXPAND_ROLES_FIELD_NUMBER
static int	OUTPUT_GROUP_EDGES_FIELD_NUMBER
static int	OUTPUT_RESOURCE_EDGES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	getAnalyzeServiceAccountImpersonation() Optional.
static IamPolicyAnalysisQuery.Options	getDefaultInstance()
IamPolicyAnalysisQuery.Options	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
boolean	getExpandGroups() Optional.
boolean	getExpandResources() Optional.
boolean	getExpandRoles() Optional.
boolean	getOutputGroupEdges() Optional.
boolean	getOutputResourceEdges() Optional.
Parser<IamPolicyAnalysisQuery.Options>	getParserForType()
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static IamPolicyAnalysisQuery.Options.Builder	newBuilder()
static IamPolicyAnalysisQuery.Options.Builder	newBuilder(IamPolicyAnalysisQuery.Options prototype)
IamPolicyAnalysisQuery.Options.Builder	newBuilderForType()
protected IamPolicyAnalysisQuery.Options.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static IamPolicyAnalysisQuery.Options	parseDelimitedFrom(InputStream input)
static IamPolicyAnalysisQuery.Options	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static IamPolicyAnalysisQuery.Options	parseFrom(byte[] data)
static IamPolicyAnalysisQuery.Options	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static IamPolicyAnalysisQuery.Options	parseFrom(ByteBuffer data)
static IamPolicyAnalysisQuery.Options	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static IamPolicyAnalysisQuery.Options	parseFrom(ByteString data)
static IamPolicyAnalysisQuery.Options	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static IamPolicyAnalysisQuery.Options	parseFrom(CodedInputStream input)
static IamPolicyAnalysisQuery.Options	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static IamPolicyAnalysisQuery.Options	parseFrom(InputStream input)
static IamPolicyAnalysisQuery.Options	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<IamPolicyAnalysisQuery.Options>	parser()
IamPolicyAnalysisQuery.Options.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

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(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class 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 GCP
 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
 resource cannot be used together with this option.
 For example, if the request analyzes for which users have permission P on
 a GCP 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 GCP folder F, then user A potentially has access to the GCP 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 GCP 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 GCP folder F, then user A potentially has access to the GCP 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 MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static IamPolicyAnalysisQuery.Options parseFrom(ByteBuffer data)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static IamPolicyAnalysisQuery.Options parseFrom(ByteBuffer data,
                                                       ExtensionRegistryLite extensionRegistry)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static IamPolicyAnalysisQuery.Options parseFrom(ByteString data)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static IamPolicyAnalysisQuery.Options parseFrom(ByteString data,
                                                       ExtensionRegistryLite extensionRegistry)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static IamPolicyAnalysisQuery.Options parseFrom(byte[] data)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static IamPolicyAnalysisQuery.Options parseFrom(byte[] data,
                                                       ExtensionRegistryLite extensionRegistry)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static IamPolicyAnalysisQuery.Options parseFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static IamPolicyAnalysisQuery.Options parseFrom(InputStream input,
                                                       ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static IamPolicyAnalysisQuery.Options parseDelimitedFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static IamPolicyAnalysisQuery.Options parseDelimitedFrom(InputStream input,
                                                                ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseFrom

public static IamPolicyAnalysisQuery.Options parseFrom(CodedInputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static IamPolicyAnalysisQuery.Options parseFrom(CodedInputStream input,
                                                       ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

newBuilderForType

public IamPolicyAnalysisQuery.Options.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static IamPolicyAnalysisQuery.Options.Builder newBuilder()

newBuilder

public static IamPolicyAnalysisQuery.Options.Builder newBuilder(IamPolicyAnalysisQuery.Options prototype)

toBuilder

public IamPolicyAnalysisQuery.Options.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected IamPolicyAnalysisQuery.Options.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static IamPolicyAnalysisQuery.Options getDefaultInstance()

parser

public static Parser<IamPolicyAnalysisQuery.Options> parser()

getParserForType

public Parser<IamPolicyAnalysisQuery.Options> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public IamPolicyAnalysisQuery.Options getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder