Class ExplainedDenyPolicy.Builder (1.50.0)

public static final class ExplainedDenyPolicy.Builder extends GeneratedMessageV3.Builder<ExplainedDenyPolicy.Builder> implements ExplainedDenyPolicyOrBuilder

Details about how a specific IAM deny policy Policy contributed to the access check.

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

Static Methods

getDescriptor()

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

Methods

addAllRuleExplanations(Iterable<? extends DenyRuleExplanation> values)

public ExplainedDenyPolicy.Builder addAllRuleExplanations(Iterable<? extends DenyRuleExplanation> values)

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation>
Returns
Type Description
ExplainedDenyPolicy.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addRuleExplanations(DenyRuleExplanation value)

public ExplainedDenyPolicy.Builder addRuleExplanations(DenyRuleExplanation value)

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Parameter
Name Description
value DenyRuleExplanation
Returns
Type Description
ExplainedDenyPolicy.Builder

addRuleExplanations(DenyRuleExplanation.Builder builderForValue)

public ExplainedDenyPolicy.Builder addRuleExplanations(DenyRuleExplanation.Builder builderForValue)

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Parameter
Name Description
builderForValue DenyRuleExplanation.Builder
Returns
Type Description
ExplainedDenyPolicy.Builder

addRuleExplanations(int index, DenyRuleExplanation value)

public ExplainedDenyPolicy.Builder addRuleExplanations(int index, DenyRuleExplanation value)

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Parameters
Name Description
index int
value DenyRuleExplanation
Returns
Type Description
ExplainedDenyPolicy.Builder

addRuleExplanations(int index, DenyRuleExplanation.Builder builderForValue)

public ExplainedDenyPolicy.Builder addRuleExplanations(int index, DenyRuleExplanation.Builder builderForValue)

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Parameters
Name Description
index int
builderForValue DenyRuleExplanation.Builder
Returns
Type Description
ExplainedDenyPolicy.Builder

addRuleExplanationsBuilder()

public DenyRuleExplanation.Builder addRuleExplanationsBuilder()

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Returns
Type Description
DenyRuleExplanation.Builder

addRuleExplanationsBuilder(int index)

public DenyRuleExplanation.Builder addRuleExplanationsBuilder(int index)

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Parameter
Name Description
index int
Returns
Type Description
DenyRuleExplanation.Builder

build()

public ExplainedDenyPolicy build()
Returns
Type Description
ExplainedDenyPolicy

buildPartial()

public ExplainedDenyPolicy buildPartial()
Returns
Type Description
ExplainedDenyPolicy

clear()

public ExplainedDenyPolicy.Builder clear()
Returns
Type Description
ExplainedDenyPolicy.Builder
Overrides

clearDenyAccessState()

public ExplainedDenyPolicy.Builder clearDenyAccessState()

Required. Indicates whether this policy denies the specified permission to the specified principal for the specified resource.

This field does not indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the overall_access_state field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.iam.v3.DenyAccessState deny_access_state = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ExplainedDenyPolicy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPolicy()

public ExplainedDenyPolicy.Builder clearPolicy()

The IAM deny policy attached to the resource.

If the sender of the request does not have access to the policy, this field is omitted.

.google.iam.v2.Policy policy = 2;

Returns
Type Description
ExplainedDenyPolicy.Builder

clearRelevance()

public ExplainedDenyPolicy.Builder clearRelevance()

The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse.

If the sender of the request does not have access to the policy, this field is omitted.

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

Returns
Type Description
ExplainedDenyPolicy.Builder

This builder for chaining.

clearRuleExplanations()

public ExplainedDenyPolicy.Builder clearRuleExplanations()

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Returns
Type Description
ExplainedDenyPolicy.Builder

clone()

public ExplainedDenyPolicy.Builder clone()
Returns
Type Description
ExplainedDenyPolicy.Builder
Overrides

getDefaultInstanceForType()

public ExplainedDenyPolicy getDefaultInstanceForType()
Returns
Type Description
ExplainedDenyPolicy

getDenyAccessState()

public DenyAccessState getDenyAccessState()

Required. Indicates whether this policy denies the specified permission to the specified principal for the specified resource.

This field does not indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the overall_access_state field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.iam.v3.DenyAccessState deny_access_state = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DenyAccessState

The denyAccessState.

getDenyAccessStateValue()

public int getDenyAccessStateValue()

Required. Indicates whether this policy denies the specified permission to the specified principal for the specified resource.

This field does not indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the overall_access_state field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.iam.v3.DenyAccessState deny_access_state = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for denyAccessState.

getDescriptorForType()

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

getPolicy()

public Policy getPolicy()

The IAM deny policy attached to the resource.

If the sender of the request does not have access to the policy, this field is omitted.

.google.iam.v2.Policy policy = 2;

Returns
Type Description
com.google.iam.v2.Policy

The policy.

getPolicyBuilder()

public Policy.Builder getPolicyBuilder()

The IAM deny policy attached to the resource.

If the sender of the request does not have access to the policy, this field is omitted.

.google.iam.v2.Policy policy = 2;

Returns
Type Description
com.google.iam.v2.Policy.Builder

getPolicyOrBuilder()

public PolicyOrBuilder getPolicyOrBuilder()

The IAM deny policy attached to the resource.

If the sender of the request does not have access to the policy, this field is omitted.

.google.iam.v2.Policy policy = 2;

Returns
Type Description
com.google.iam.v2.PolicyOrBuilder

getRelevance()

public HeuristicRelevance getRelevance()

The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse.

If the sender of the request does not have access to the policy, this field is omitted.

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

Returns
Type Description
HeuristicRelevance

The relevance.

getRelevanceValue()

public int getRelevanceValue()

The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse.

If the sender of the request does not have access to the policy, this field is omitted.

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

Returns
Type Description
int

The enum numeric value on the wire for relevance.

getRuleExplanations(int index)

public DenyRuleExplanation getRuleExplanations(int index)

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Parameter
Name Description
index int
Returns
Type Description
DenyRuleExplanation

getRuleExplanationsBuilder(int index)

public DenyRuleExplanation.Builder getRuleExplanationsBuilder(int index)

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Parameter
Name Description
index int
Returns
Type Description
DenyRuleExplanation.Builder

getRuleExplanationsBuilderList()

public List<DenyRuleExplanation.Builder> getRuleExplanationsBuilderList()

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Returns
Type Description
List<Builder>

getRuleExplanationsCount()

public int getRuleExplanationsCount()

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Returns
Type Description
int

getRuleExplanationsList()

public List<DenyRuleExplanation> getRuleExplanationsList()

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Returns
Type Description
List<DenyRuleExplanation>

getRuleExplanationsOrBuilder(int index)

public DenyRuleExplanationOrBuilder getRuleExplanationsOrBuilder(int index)

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Parameter
Name Description
index int
Returns
Type Description
DenyRuleExplanationOrBuilder

getRuleExplanationsOrBuilderList()

public List<? extends DenyRuleExplanationOrBuilder> getRuleExplanationsOrBuilderList()

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Returns
Type Description
List<? extends com.google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanationOrBuilder>

hasPolicy()

public boolean hasPolicy()

The IAM deny policy attached to the resource.

If the sender of the request does not have access to the policy, this field is omitted.

.google.iam.v2.Policy policy = 2;

Returns
Type Description
boolean

Whether the policy field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ExplainedDenyPolicy other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergePolicy(Policy value)

public ExplainedDenyPolicy.Builder mergePolicy(Policy value)

The IAM deny policy attached to the resource.

If the sender of the request does not have access to the policy, this field is omitted.

.google.iam.v2.Policy policy = 2;

Parameter
Name Description
value com.google.iam.v2.Policy
Returns
Type Description
ExplainedDenyPolicy.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeRuleExplanations(int index)

public ExplainedDenyPolicy.Builder removeRuleExplanations(int index)

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Parameter
Name Description
index int
Returns
Type Description
ExplainedDenyPolicy.Builder

setDenyAccessState(DenyAccessState value)

public ExplainedDenyPolicy.Builder setDenyAccessState(DenyAccessState value)

Required. Indicates whether this policy denies the specified permission to the specified principal for the specified resource.

This field does not indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the overall_access_state field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.iam.v3.DenyAccessState deny_access_state = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value DenyAccessState

The denyAccessState to set.

Returns
Type Description
ExplainedDenyPolicy.Builder

This builder for chaining.

setDenyAccessStateValue(int value)

public ExplainedDenyPolicy.Builder setDenyAccessStateValue(int value)

Required. Indicates whether this policy denies the specified permission to the specified principal for the specified resource.

This field does not indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the overall_access_state field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.iam.v3.DenyAccessState deny_access_state = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

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

Returns
Type Description
ExplainedDenyPolicy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setPolicy(Policy value)

public ExplainedDenyPolicy.Builder setPolicy(Policy value)

The IAM deny policy attached to the resource.

If the sender of the request does not have access to the policy, this field is omitted.

.google.iam.v2.Policy policy = 2;

Parameter
Name Description
value com.google.iam.v2.Policy
Returns
Type Description
ExplainedDenyPolicy.Builder

setPolicy(Policy.Builder builderForValue)

public ExplainedDenyPolicy.Builder setPolicy(Policy.Builder builderForValue)

The IAM deny policy attached to the resource.

If the sender of the request does not have access to the policy, this field is omitted.

.google.iam.v2.Policy policy = 2;

Parameter
Name Description
builderForValue com.google.iam.v2.Policy.Builder
Returns
Type Description
ExplainedDenyPolicy.Builder

setRelevance(HeuristicRelevance value)

public ExplainedDenyPolicy.Builder setRelevance(HeuristicRelevance value)

The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse.

If the sender of the request does not have access to the policy, this field is omitted.

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

Parameter
Name Description
value HeuristicRelevance

The relevance to set.

Returns
Type Description
ExplainedDenyPolicy.Builder

This builder for chaining.

setRelevanceValue(int value)

public ExplainedDenyPolicy.Builder setRelevanceValue(int value)

The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse.

If the sender of the request does not have access to the policy, this field is omitted.

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

Parameter
Name Description
value int

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

Returns
Type Description
ExplainedDenyPolicy.Builder

This builder for chaining.

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

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

setRuleExplanations(int index, DenyRuleExplanation value)

public ExplainedDenyPolicy.Builder setRuleExplanations(int index, DenyRuleExplanation value)

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Parameters
Name Description
index int
value DenyRuleExplanation
Returns
Type Description
ExplainedDenyPolicy.Builder

setRuleExplanations(int index, DenyRuleExplanation.Builder builderForValue)

public ExplainedDenyPolicy.Builder setRuleExplanations(int index, DenyRuleExplanation.Builder builderForValue)

Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanation rule_explanations = 3;

Parameters
Name Description
index int
builderForValue DenyRuleExplanation.Builder
Returns
Type Description
ExplainedDenyPolicy.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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