Class ExplainedDenyPolicy (1.41.0)

public final class ExplainedDenyPolicy extends GeneratedMessageV3 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 Fields

DENY_ACCESS_STATE_FIELD_NUMBER

public static final int DENY_ACCESS_STATE_FIELD_NUMBER
Field Value
Type Description
int

POLICY_FIELD_NUMBER

public static final int POLICY_FIELD_NUMBER
Field Value
Type Description
int

RELEVANCE_FIELD_NUMBER

public static final int RELEVANCE_FIELD_NUMBER
Field Value
Type Description
int

RULE_EXPLANATIONS_FIELD_NUMBER

public static final int RULE_EXPLANATIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExplainedDenyPolicy getDefaultInstance()
Returns
Type Description
ExplainedDenyPolicy

getDescriptor()

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

newBuilder()

public static ExplainedDenyPolicy.Builder newBuilder()
Returns
Type Description
ExplainedDenyPolicy.Builder

newBuilder(ExplainedDenyPolicy prototype)

public static ExplainedDenyPolicy.Builder newBuilder(ExplainedDenyPolicy prototype)
Parameter
Name Description
prototype ExplainedDenyPolicy
Returns
Type Description
ExplainedDenyPolicy.Builder

parseDelimitedFrom(InputStream input)

public static ExplainedDenyPolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplainedDenyPolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainedDenyPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainedDenyPolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExplainedDenyPolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExplainedDenyPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExplainedDenyPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainedDenyPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExplainedDenyPolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExplainedDenyPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExplainedDenyPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainedDenyPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExplainedDenyPolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExplainedDenyPolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainedDenyPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainedDenyPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExplainedDenyPolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplainedDenyPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainedDenyPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainedDenyPolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExplainedDenyPolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExplainedDenyPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExplainedDenyPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainedDenyPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExplainedDenyPolicy> parser()
Returns
Type Description
Parser<ExplainedDenyPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

getParserForType()

public Parser<ExplainedDenyPolicy> getParserForType()
Returns
Type Description
Parser<ExplainedDenyPolicy>
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.

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

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>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExplainedDenyPolicy.Builder newBuilderForType()
Returns
Type Description
ExplainedDenyPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExplainedDenyPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExplainedDenyPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExplainedDenyPolicy.Builder toBuilder()
Returns
Type Description
ExplainedDenyPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException