Class AnalyzeIamPolicyRequest.Options.Builder (3.2.17) 

public static final class AnalyzeIamPolicyRequest.Options.Builder extends GeneratedMessageV3.Builder<AnalyzeIamPolicyRequest.Options.Builder> implements AnalyzeIamPolicyRequest.OptionsOrBuilder

Contains request options.

Protobuf type google.cloud.asset.v1p4beta1.AnalyzeIamPolicyRequest.Options

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AnalyzeIamPolicyRequest.Options.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AnalyzeIamPolicyRequest.Options.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder
Overrides

build()

public AnalyzeIamPolicyRequest.Options build()
Returns
Type Description
AnalyzeIamPolicyRequest.Options

buildPartial()

public AnalyzeIamPolicyRequest.Options buildPartial()
Returns
Type Description
AnalyzeIamPolicyRequest.Options

clear()

public AnalyzeIamPolicyRequest.Options.Builder clear()
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder
Overrides

clearAnalyzeServiceAccountImpersonation()

public AnalyzeIamPolicyRequest.Options.Builder clearAnalyzeServiceAccountImpersonation()

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 ExportIamPolicyAnalysis 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. 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. Default is false.

bool analyze_service_account_impersonation = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

This builder for chaining.

clearExecutionTimeout()

public AnalyzeIamPolicyRequest.Options.Builder clearExecutionTimeout()

Optional. Amount of time executable has to complete. See JSON representation of Duration. If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty.

.google.protobuf.Duration execution_timeout = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

clearExpandGroups()

public AnalyzeIamPolicyRequest.Options.Builder clearExpandGroups()

Optional. If true, the identities section of the result will expand any Google groups appearing in an IAM policy binding. If [identity_selector][] is specified, the identity in the result will be determined by the selector, and this flag will have no effect. Default is false.

bool expand_groups = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

This builder for chaining.

clearExpandResources()

public AnalyzeIamPolicyRequest.Options.Builder clearExpandResources()

Optional. If true, 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 [resource_selector][] is specified, the resource section of the result will be determined by the selector, and this flag will have no effect. Default is false.

bool expand_resources = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

This builder for chaining.

clearExpandRoles()

public AnalyzeIamPolicyRequest.Options.Builder clearExpandRoles()

Optional. If true, the access section of result will expand any roles appearing in IAM policy bindings to include their permissions. If [access_selector][] is specified, the access section of the result will be determined by the selector, and this flag will have no effect. Default is false.

bool expand_roles = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AnalyzeIamPolicyRequest.Options.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public AnalyzeIamPolicyRequest.Options.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder
Overrides

clearOutputGroupEdges()

public AnalyzeIamPolicyRequest.Options.Builder clearOutputGroupEdges()

Optional. If true, the result will output group identity edges, starting from the binding's group members, to any expanded identities. Default is false.

bool output_group_edges = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

This builder for chaining.

clearOutputResourceEdges()

public AnalyzeIamPolicyRequest.Options.Builder clearOutputResourceEdges()

Optional. If true, the result will output resource edges, starting from the policy attached resource, to any expanded resources. Default is false.

bool output_resource_edges = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

This builder for chaining.

clone()

public AnalyzeIamPolicyRequest.Options.Builder clone()
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder
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 ExportIamPolicyAnalysis 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. 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. Default is false.

bool analyze_service_account_impersonation = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The analyzeServiceAccountImpersonation.

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExecutionTimeout()

public Duration getExecutionTimeout()

Optional. Amount of time executable has to complete. See JSON representation of Duration. If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty.

.google.protobuf.Duration execution_timeout = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The executionTimeout.

getExecutionTimeoutBuilder()

public Duration.Builder getExecutionTimeoutBuilder()

Optional. Amount of time executable has to complete. See JSON representation of Duration. If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty.

.google.protobuf.Duration execution_timeout = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getExecutionTimeoutOrBuilder()

public DurationOrBuilder getExecutionTimeoutOrBuilder()

Optional. Amount of time executable has to complete. See JSON representation of Duration. If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty.

.google.protobuf.Duration execution_timeout = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

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 [identity_selector][] is specified, the identity in the result will be determined by the selector, and this flag will have no effect. 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, 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 [resource_selector][] is specified, the resource section of the result will be determined by the selector, and this flag will have no effect. 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 [access_selector][] is specified, the access section of the result will be determined by the selector, and this flag will have no effect. 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 group identity edges, starting from the binding's group members, to any expanded identities. 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 resource edges, starting from the policy attached resource, to any expanded resources. Default is false.

bool output_resource_edges = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The outputResourceEdges.

hasExecutionTimeout()

public boolean hasExecutionTimeout()

Optional. Amount of time executable has to complete. See JSON representation of Duration. If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty.

.google.protobuf.Duration execution_timeout = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the executionTimeout field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeExecutionTimeout(Duration value)

public AnalyzeIamPolicyRequest.Options.Builder mergeExecutionTimeout(Duration value)

Optional. Amount of time executable has to complete. See JSON representation of Duration. If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty.

.google.protobuf.Duration execution_timeout = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Duration
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

mergeFrom(AnalyzeIamPolicyRequest.Options other)

public AnalyzeIamPolicyRequest.Options.Builder mergeFrom(AnalyzeIamPolicyRequest.Options other)
Parameter
Name Description
other AnalyzeIamPolicyRequest.Options
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AnalyzeIamPolicyRequest.Options.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public AnalyzeIamPolicyRequest.Options.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AnalyzeIamPolicyRequest.Options.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder
Overrides

setAnalyzeServiceAccountImpersonation(boolean value)

public AnalyzeIamPolicyRequest.Options.Builder setAnalyzeServiceAccountImpersonation(boolean value)

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 ExportIamPolicyAnalysis 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. 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. Default is false.

bool analyze_service_account_impersonation = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The analyzeServiceAccountImpersonation to set.
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

This builder for chaining.

setExecutionTimeout(Duration value)

public AnalyzeIamPolicyRequest.Options.Builder setExecutionTimeout(Duration value)

Optional. Amount of time executable has to complete. See JSON representation of Duration. If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty.

.google.protobuf.Duration execution_timeout = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Duration
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

setExecutionTimeout(Duration.Builder builderForValue)

public AnalyzeIamPolicyRequest.Options.Builder setExecutionTimeout(Duration.Builder builderForValue)

Optional. Amount of time executable has to complete. See JSON representation of Duration. If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty.

.google.protobuf.Duration execution_timeout = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

setExpandGroups(boolean value)

public AnalyzeIamPolicyRequest.Options.Builder setExpandGroups(boolean value)

Optional. If true, the identities section of the result will expand any Google groups appearing in an IAM policy binding. If [identity_selector][] is specified, the identity in the result will be determined by the selector, and this flag will have no effect. Default is false.

bool expand_groups = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The expandGroups to set.
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

This builder for chaining.

setExpandResources(boolean value)

public AnalyzeIamPolicyRequest.Options.Builder setExpandResources(boolean value)

Optional. If true, 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 [resource_selector][] is specified, the resource section of the result will be determined by the selector, and this flag will have no effect. Default is false.

bool expand_resources = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The expandResources to set.
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

This builder for chaining.

setExpandRoles(boolean value)

public AnalyzeIamPolicyRequest.Options.Builder setExpandRoles(boolean value)

Optional. If true, the access section of result will expand any roles appearing in IAM policy bindings to include their permissions. If [access_selector][] is specified, the access section of the result will be determined by the selector, and this flag will have no effect. Default is false.

bool expand_roles = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The expandRoles to set.
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AnalyzeIamPolicyRequest.Options.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder
Overrides

setOutputGroupEdges(boolean value)

public AnalyzeIamPolicyRequest.Options.Builder setOutputGroupEdges(boolean value)

Optional. If true, the result will output group identity edges, starting from the binding's group members, to any expanded identities. Default is false.

bool output_group_edges = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The outputGroupEdges to set.
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

This builder for chaining.

setOutputResourceEdges(boolean value)

public AnalyzeIamPolicyRequest.Options.Builder setOutputResourceEdges(boolean value)

Optional. If true, the result will output resource edges, starting from the policy attached resource, to any expanded resources. Default is false.

bool output_resource_edges = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The outputResourceEdges to set.
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AnalyzeIamPolicyRequest.Options.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AnalyzeIamPolicyRequest.Options.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnalyzeIamPolicyRequest.Options.Builder
Overrides