Class DenyPolicyExplanation (1.54.0)

public final class DenyPolicyExplanation extends GeneratedMessageV3 implements DenyPolicyExplanationOrBuilder

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

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

Static Fields

DENY_ACCESS_STATE_FIELD_NUMBER

public static final int DENY_ACCESS_STATE_FIELD_NUMBER
Field Value
Type Description
int

EXPLAINED_RESOURCES_FIELD_NUMBER

public static final int EXPLAINED_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

PERMISSION_DENIABLE_FIELD_NUMBER

public static final int PERMISSION_DENIABLE_FIELD_NUMBER
Field Value
Type Description
int

RELEVANCE_FIELD_NUMBER

public static final int RELEVANCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DenyPolicyExplanation getDefaultInstance()
Returns
Type Description
DenyPolicyExplanation

getDescriptor()

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

newBuilder()

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

newBuilder(DenyPolicyExplanation prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DenyPolicyExplanation getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
int

The enum numeric value on the wire for denyAccessState.

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
Name Description
index int
Returns
Type Description
ExplainedDenyResource

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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.cloud.policytroubleshooter.iam.v3.ExplainedDenyResourceOrBuilder>

getParserForType()

public Parser<DenyPolicyExplanation> getParserForType()
Returns
Type Description
Parser<DenyPolicyExplanation>
Overrides

getPermissionDeniable()

public boolean getPermissionDeniable()

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

bool permission_deniable = 4;

Returns
Type Description
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
Type Description
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
Type Description
int

The enum numeric value on the wire for relevance.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 DenyPolicyExplanation.Builder newBuilderForType()
Returns
Type Description
DenyPolicyExplanation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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