Class DenyPolicyExplanation.Builder (1.26.0)

public static final class DenyPolicyExplanation.Builder extends GeneratedMessageV3.Builder<DenyPolicyExplanation.Builder> implements DenyPolicyExplanationOrBuilder

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

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

Static Methods

getDescriptor()

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

Methods

addAllExplainedResources(Iterable<? extends ExplainedDenyResource> values)

public DenyPolicyExplanation.Builder addAllExplainedResources(Iterable<? extends ExplainedDenyResource> values)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

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

addExplainedResources(ExplainedDenyResource value)

public DenyPolicyExplanation.Builder addExplainedResources(ExplainedDenyResource value)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Parameter
NameDescription
valueExplainedDenyResource
Returns
TypeDescription
DenyPolicyExplanation.Builder

addExplainedResources(ExplainedDenyResource.Builder builderForValue)

public DenyPolicyExplanation.Builder addExplainedResources(ExplainedDenyResource.Builder builderForValue)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Parameter
NameDescription
builderForValueExplainedDenyResource.Builder
Returns
TypeDescription
DenyPolicyExplanation.Builder

addExplainedResources(int index, ExplainedDenyResource value)

public DenyPolicyExplanation.Builder addExplainedResources(int index, ExplainedDenyResource value)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Parameters
NameDescription
indexint
valueExplainedDenyResource
Returns
TypeDescription
DenyPolicyExplanation.Builder

addExplainedResources(int index, ExplainedDenyResource.Builder builderForValue)

public DenyPolicyExplanation.Builder addExplainedResources(int index, ExplainedDenyResource.Builder builderForValue)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Parameters
NameDescription
indexint
builderForValueExplainedDenyResource.Builder
Returns
TypeDescription
DenyPolicyExplanation.Builder

addExplainedResourcesBuilder()

public ExplainedDenyResource.Builder addExplainedResourcesBuilder()

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Returns
TypeDescription
ExplainedDenyResource.Builder

addExplainedResourcesBuilder(int index)

public ExplainedDenyResource.Builder addExplainedResourcesBuilder(int index)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExplainedDenyResource.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public DenyPolicyExplanation build()
Returns
TypeDescription
DenyPolicyExplanation

buildPartial()

public DenyPolicyExplanation buildPartial()
Returns
TypeDescription
DenyPolicyExplanation

clear()

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

clearDenyAccessState()

public DenyPolicyExplanation.Builder clearDenyAccessState()

Indicates whether the principal is denied the specified permission for the specified resource, based on evaluating all applicable IAM deny policies.

.google.cloud.policytroubleshooter.iam.v3.DenyAccessState deny_access_state = 1;

Returns
TypeDescription
DenyPolicyExplanation.Builder

This builder for chaining.

clearExplainedResources()

public DenyPolicyExplanation.Builder clearExplainedResources()

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Returns
TypeDescription
DenyPolicyExplanation.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPermissionDeniable()

public DenyPolicyExplanation.Builder clearPermissionDeniable()

Indicates whether the permission to troubleshoot is supported in deny policies.

bool permission_deniable = 4;

Returns
TypeDescription
DenyPolicyExplanation.Builder

This builder for chaining.

clearRelevance()

public DenyPolicyExplanation.Builder clearRelevance()

The relevance of the deny policy result to the overall access state.

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

Returns
TypeDescription
DenyPolicyExplanation.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public DenyPolicyExplanation getDefaultInstanceForType()
Returns
TypeDescription
DenyPolicyExplanation

getDenyAccessState()

public DenyAccessState getDenyAccessState()

Indicates whether the principal is denied the specified permission for the specified resource, based on evaluating all applicable IAM deny policies.

.google.cloud.policytroubleshooter.iam.v3.DenyAccessState deny_access_state = 1;

Returns
TypeDescription
DenyAccessState

The denyAccessState.

getDenyAccessStateValue()

public int getDenyAccessStateValue()

Indicates whether the principal is denied the specified permission for the specified resource, based on evaluating all applicable IAM deny policies.

.google.cloud.policytroubleshooter.iam.v3.DenyAccessState deny_access_state = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for denyAccessState.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getExplainedResources(int index)

public ExplainedDenyResource getExplainedResources(int index)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExplainedDenyResource

getExplainedResourcesBuilder(int index)

public ExplainedDenyResource.Builder getExplainedResourcesBuilder(int index)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExplainedDenyResource.Builder

getExplainedResourcesBuilderList()

public List<ExplainedDenyResource.Builder> getExplainedResourcesBuilderList()

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Returns
TypeDescription
List<Builder>

getExplainedResourcesCount()

public int getExplainedResourcesCount()

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Returns
TypeDescription
int

getExplainedResourcesList()

public List<ExplainedDenyResource> getExplainedResourcesList()

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Returns
TypeDescription
List<ExplainedDenyResource>

getExplainedResourcesOrBuilder(int index)

public ExplainedDenyResourceOrBuilder getExplainedResourcesOrBuilder(int index)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExplainedDenyResourceOrBuilder

getExplainedResourcesOrBuilderList()

public List<? extends ExplainedDenyResourceOrBuilder> getExplainedResourcesOrBuilderList()

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

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

getPermissionDeniable()

public boolean getPermissionDeniable()

Indicates whether the permission to troubleshoot is supported in deny policies.

bool permission_deniable = 4;

Returns
TypeDescription
boolean

The permissionDeniable.

getRelevance()

public HeuristicRelevance getRelevance()

The relevance of the deny policy result 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 deny policy result 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(DenyPolicyExplanation other)

public DenyPolicyExplanation.Builder mergeFrom(DenyPolicyExplanation other)
Parameter
NameDescription
otherDenyPolicyExplanation
Returns
TypeDescription
DenyPolicyExplanation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeExplainedResources(int index)

public DenyPolicyExplanation.Builder removeExplainedResources(int index)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
DenyPolicyExplanation.Builder

setDenyAccessState(DenyAccessState value)

public DenyPolicyExplanation.Builder setDenyAccessState(DenyAccessState value)

Indicates whether the principal is denied the specified permission for the specified resource, based on evaluating all applicable IAM deny policies.

.google.cloud.policytroubleshooter.iam.v3.DenyAccessState deny_access_state = 1;

Parameter
NameDescription
valueDenyAccessState

The denyAccessState to set.

Returns
TypeDescription
DenyPolicyExplanation.Builder

This builder for chaining.

setDenyAccessStateValue(int value)

public DenyPolicyExplanation.Builder setDenyAccessStateValue(int value)

Indicates whether the principal is denied the specified permission for the specified resource, based on evaluating all applicable IAM deny policies.

.google.cloud.policytroubleshooter.iam.v3.DenyAccessState deny_access_state = 1;

Parameter
NameDescription
valueint

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

Returns
TypeDescription
DenyPolicyExplanation.Builder

This builder for chaining.

setExplainedResources(int index, ExplainedDenyResource value)

public DenyPolicyExplanation.Builder setExplainedResources(int index, ExplainedDenyResource value)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Parameters
NameDescription
indexint
valueExplainedDenyResource
Returns
TypeDescription
DenyPolicyExplanation.Builder

setExplainedResources(int index, ExplainedDenyResource.Builder builderForValue)

public DenyPolicyExplanation.Builder setExplainedResources(int index, ExplainedDenyResource.Builder builderForValue)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResource explained_resources = 2;

Parameters
NameDescription
indexint
builderForValueExplainedDenyResource.Builder
Returns
TypeDescription
DenyPolicyExplanation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setPermissionDeniable(boolean value)

public DenyPolicyExplanation.Builder setPermissionDeniable(boolean value)

Indicates whether the permission to troubleshoot is supported in deny policies.

bool permission_deniable = 4;

Parameter
NameDescription
valueboolean

The permissionDeniable to set.

Returns
TypeDescription
DenyPolicyExplanation.Builder

This builder for chaining.

setRelevance(HeuristicRelevance value)

public DenyPolicyExplanation.Builder setRelevance(HeuristicRelevance value)

The relevance of the deny policy result to the overall access state.

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

Parameter
NameDescription
valueHeuristicRelevance

The relevance to set.

Returns
TypeDescription
DenyPolicyExplanation.Builder

This builder for chaining.

setRelevanceValue(int value)

public DenyPolicyExplanation.Builder setRelevanceValue(int value)

The relevance of the deny policy result 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
DenyPolicyExplanation.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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