Class ExplainedDenyPolicy (1.31.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
TypeDescription
int

POLICY_FIELD_NUMBER

public static final int POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

RELEVANCE_FIELD_NUMBER

public static final int RELEVANCE_FIELD_NUMBER
Field Value
TypeDescription
int

RULE_EXPLANATIONS_FIELD_NUMBER

public static final int RULE_EXPLANATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExplainedDenyPolicy getDefaultInstance()
Returns
TypeDescription
ExplainedDenyPolicy

getDescriptor()

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

newBuilder()

public static ExplainedDenyPolicy.Builder newBuilder()
Returns
TypeDescription
ExplainedDenyPolicy.Builder

newBuilder(ExplainedDenyPolicy prototype)

public static ExplainedDenyPolicy.Builder newBuilder(ExplainedDenyPolicy prototype)
Parameter
NameDescription
prototypeExplainedDenyPolicy
Returns
TypeDescription
ExplainedDenyPolicy.Builder

parseDelimitedFrom(InputStream input)

public static ExplainedDenyPolicy parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExplainedDenyPolicy
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainedDenyPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainedDenyPolicy
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExplainedDenyPolicy parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExplainedDenyPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExplainedDenyPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainedDenyPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExplainedDenyPolicy parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExplainedDenyPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExplainedDenyPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainedDenyPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExplainedDenyPolicy parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExplainedDenyPolicy
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainedDenyPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainedDenyPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExplainedDenyPolicy parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExplainedDenyPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainedDenyPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainedDenyPolicy
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExplainedDenyPolicy parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExplainedDenyPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExplainedDenyPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainedDenyPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExplainedDenyPolicy> parser()
Returns
TypeDescription
Parser<ExplainedDenyPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ExplainedDenyPolicy getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for denyAccessState.

getParserForType()

public Parser<ExplainedDenyPolicy> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.policytroubleshooter.iam.v3.DenyRuleExplanationOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
boolean

Whether the policy field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExplainedDenyPolicy.Builder newBuilderForType()
Returns
TypeDescription
ExplainedDenyPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExplainedDenyPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExplainedDenyPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExplainedDenyPolicy.Builder toBuilder()
Returns
TypeDescription
ExplainedDenyPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException