Class AllowPolicyExplanation.Builder (1.35.0)

public static final class AllowPolicyExplanation.Builder extends GeneratedMessageV3.Builder<AllowPolicyExplanation.Builder> implements AllowPolicyExplanationOrBuilder

Details about how the relevant IAM allow policies affect the final access state.

Protobuf type google.cloud.policytroubleshooter.iam.v3.AllowPolicyExplanation

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllExplainedPolicies(Iterable<? extends ExplainedAllowPolicy> values)

public AllowPolicyExplanation.Builder addAllExplainedPolicies(Iterable<? extends ExplainedAllowPolicy> values)

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy>
Returns
TypeDescription
AllowPolicyExplanation.Builder

addExplainedPolicies(ExplainedAllowPolicy value)

public AllowPolicyExplanation.Builder addExplainedPolicies(ExplainedAllowPolicy value)

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameter
NameDescription
valueExplainedAllowPolicy
Returns
TypeDescription
AllowPolicyExplanation.Builder

addExplainedPolicies(ExplainedAllowPolicy.Builder builderForValue)

public AllowPolicyExplanation.Builder addExplainedPolicies(ExplainedAllowPolicy.Builder builderForValue)

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameter
NameDescription
builderForValueExplainedAllowPolicy.Builder
Returns
TypeDescription
AllowPolicyExplanation.Builder

addExplainedPolicies(int index, ExplainedAllowPolicy value)

public AllowPolicyExplanation.Builder addExplainedPolicies(int index, ExplainedAllowPolicy value)

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameters
NameDescription
indexint
valueExplainedAllowPolicy
Returns
TypeDescription
AllowPolicyExplanation.Builder

addExplainedPolicies(int index, ExplainedAllowPolicy.Builder builderForValue)

public AllowPolicyExplanation.Builder addExplainedPolicies(int index, ExplainedAllowPolicy.Builder builderForValue)

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameters
NameDescription
indexint
builderForValueExplainedAllowPolicy.Builder
Returns
TypeDescription
AllowPolicyExplanation.Builder

addExplainedPoliciesBuilder()

public ExplainedAllowPolicy.Builder addExplainedPoliciesBuilder()

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Returns
TypeDescription
ExplainedAllowPolicy.Builder

addExplainedPoliciesBuilder(int index)

public ExplainedAllowPolicy.Builder addExplainedPoliciesBuilder(int index)

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExplainedAllowPolicy.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AllowPolicyExplanation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AllowPolicyExplanation.Builder
Overrides

build()

public AllowPolicyExplanation build()
Returns
TypeDescription
AllowPolicyExplanation

buildPartial()

public AllowPolicyExplanation buildPartial()
Returns
TypeDescription
AllowPolicyExplanation

clear()

public AllowPolicyExplanation.Builder clear()
Returns
TypeDescription
AllowPolicyExplanation.Builder
Overrides

clearAllowAccessState()

public AllowPolicyExplanation.Builder clearAllowAccessState()

Indicates whether the principal has the specified permission for the specified resource, based on evaluating all applicable IAM allow policies.

.google.cloud.policytroubleshooter.iam.v3.AllowAccessState allow_access_state = 1;

Returns
TypeDescription
AllowPolicyExplanation.Builder

This builder for chaining.

clearExplainedPolicies()

public AllowPolicyExplanation.Builder clearExplainedPolicies()

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Returns
TypeDescription
AllowPolicyExplanation.Builder

clearField(Descriptors.FieldDescriptor field)

public AllowPolicyExplanation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AllowPolicyExplanation.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public AllowPolicyExplanation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AllowPolicyExplanation.Builder
Overrides

clearRelevance()

public AllowPolicyExplanation.Builder clearRelevance()

The relevance of the allow policy type to the overall access state.

.google.cloud.policytroubleshooter.iam.v3.HeuristicRelevance relevance = 3;

Returns
TypeDescription
AllowPolicyExplanation.Builder

This builder for chaining.

clone()

public AllowPolicyExplanation.Builder clone()
Returns
TypeDescription
AllowPolicyExplanation.Builder
Overrides

getAllowAccessState()

public AllowAccessState getAllowAccessState()

Indicates whether the principal has the specified permission for the specified resource, based on evaluating all applicable IAM allow policies.

.google.cloud.policytroubleshooter.iam.v3.AllowAccessState allow_access_state = 1;

Returns
TypeDescription
AllowAccessState

The allowAccessState.

getAllowAccessStateValue()

public int getAllowAccessStateValue()

Indicates whether the principal has the specified permission for the specified resource, based on evaluating all applicable IAM allow policies.

.google.cloud.policytroubleshooter.iam.v3.AllowAccessState allow_access_state = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for allowAccessState.

getDefaultInstanceForType()

public AllowPolicyExplanation getDefaultInstanceForType()
Returns
TypeDescription
AllowPolicyExplanation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getExplainedPolicies(int index)

public ExplainedAllowPolicy getExplainedPolicies(int index)

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExplainedAllowPolicy

getExplainedPoliciesBuilder(int index)

public ExplainedAllowPolicy.Builder getExplainedPoliciesBuilder(int index)

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExplainedAllowPolicy.Builder

getExplainedPoliciesBuilderList()

public List<ExplainedAllowPolicy.Builder> getExplainedPoliciesBuilderList()

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Returns
TypeDescription
List<Builder>

getExplainedPoliciesCount()

public int getExplainedPoliciesCount()

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Returns
TypeDescription
int

getExplainedPoliciesList()

public List<ExplainedAllowPolicy> getExplainedPoliciesList()

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Returns
TypeDescription
List<ExplainedAllowPolicy>

getExplainedPoliciesOrBuilder(int index)

public ExplainedAllowPolicyOrBuilder getExplainedPoliciesOrBuilder(int index)

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExplainedAllowPolicyOrBuilder

getExplainedPoliciesOrBuilderList()

public List<? extends ExplainedAllowPolicyOrBuilder> getExplainedPoliciesOrBuilderList()

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Returns
TypeDescription
List<? extends com.google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicyOrBuilder>

getRelevance()

public HeuristicRelevance getRelevance()

The relevance of the allow policy type to the overall access state.

.google.cloud.policytroubleshooter.iam.v3.HeuristicRelevance relevance = 3;

Returns
TypeDescription
HeuristicRelevance

The relevance.

getRelevanceValue()

public int getRelevanceValue()

The relevance of the allow policy type to the overall access state.

.google.cloud.policytroubleshooter.iam.v3.HeuristicRelevance relevance = 3;

Returns
TypeDescription
int

The enum numeric value on the wire for relevance.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AllowPolicyExplanation other)

public AllowPolicyExplanation.Builder mergeFrom(AllowPolicyExplanation other)
Parameter
NameDescription
otherAllowPolicyExplanation
Returns
TypeDescription
AllowPolicyExplanation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AllowPolicyExplanation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AllowPolicyExplanation.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AllowPolicyExplanation.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AllowPolicyExplanation.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AllowPolicyExplanation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AllowPolicyExplanation.Builder
Overrides

removeExplainedPolicies(int index)

public AllowPolicyExplanation.Builder removeExplainedPolicies(int index)

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
AllowPolicyExplanation.Builder

setAllowAccessState(AllowAccessState value)

public AllowPolicyExplanation.Builder setAllowAccessState(AllowAccessState value)

Indicates whether the principal has the specified permission for the specified resource, based on evaluating all applicable IAM allow policies.

.google.cloud.policytroubleshooter.iam.v3.AllowAccessState allow_access_state = 1;

Parameter
NameDescription
valueAllowAccessState

The allowAccessState to set.

Returns
TypeDescription
AllowPolicyExplanation.Builder

This builder for chaining.

setAllowAccessStateValue(int value)

public AllowPolicyExplanation.Builder setAllowAccessStateValue(int value)

Indicates whether the principal has the specified permission for the specified resource, based on evaluating all applicable IAM allow policies.

.google.cloud.policytroubleshooter.iam.v3.AllowAccessState allow_access_state = 1;

Parameter
NameDescription
valueint

The enum numeric value on the wire for allowAccessState to set.

Returns
TypeDescription
AllowPolicyExplanation.Builder

This builder for chaining.

setExplainedPolicies(int index, ExplainedAllowPolicy value)

public AllowPolicyExplanation.Builder setExplainedPolicies(int index, ExplainedAllowPolicy value)

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameters
NameDescription
indexint
valueExplainedAllowPolicy
Returns
TypeDescription
AllowPolicyExplanation.Builder

setExplainedPolicies(int index, ExplainedAllowPolicy.Builder builderForValue)

public AllowPolicyExplanation.Builder setExplainedPolicies(int index, ExplainedAllowPolicy.Builder builderForValue)

List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result.

The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project.

To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameters
NameDescription
indexint
builderForValueExplainedAllowPolicy.Builder
Returns
TypeDescription
AllowPolicyExplanation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AllowPolicyExplanation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AllowPolicyExplanation.Builder
Overrides

setRelevance(HeuristicRelevance value)

public AllowPolicyExplanation.Builder setRelevance(HeuristicRelevance value)

The relevance of the allow policy type to the overall access state.

.google.cloud.policytroubleshooter.iam.v3.HeuristicRelevance relevance = 3;

Parameter
NameDescription
valueHeuristicRelevance

The relevance to set.

Returns
TypeDescription
AllowPolicyExplanation.Builder

This builder for chaining.

setRelevanceValue(int value)

public AllowPolicyExplanation.Builder setRelevanceValue(int value)

The relevance of the allow policy type to the overall access state.

.google.cloud.policytroubleshooter.iam.v3.HeuristicRelevance relevance = 3;

Parameter
NameDescription
valueint

The enum numeric value on the wire for relevance to set.

Returns
TypeDescription
AllowPolicyExplanation.Builder

This builder for chaining.

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

public AllowPolicyExplanation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AllowPolicyExplanation.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AllowPolicyExplanation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AllowPolicyExplanation.Builder
Overrides