Class AllowPolicyExplanation (1.45.0)

public final class AllowPolicyExplanation extends GeneratedMessageV3 implements AllowPolicyExplanationOrBuilder

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

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

Static Fields

ALLOW_ACCESS_STATE_FIELD_NUMBER

public static final int ALLOW_ACCESS_STATE_FIELD_NUMBER
Field Value
Type Description
int

EXPLAINED_POLICIES_FIELD_NUMBER

public static final int EXPLAINED_POLICIES_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 AllowPolicyExplanation getDefaultInstance()
Returns
Type Description
AllowPolicyExplanation

getDescriptor()

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

newBuilder()

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

newBuilder(AllowPolicyExplanation prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAllowAccessState()

public AllowAccessState getAllowAccessState()

Indicates whether the principal has the specified permission for the specified resource, based on evaluating all applicable IAM allow policies.

.google.cloud.policytroubleshooter.iam.v3.AllowAccessState allow_access_state = 1;

Returns
Type Description
AllowAccessState

The allowAccessState.

getAllowAccessStateValue()

public int getAllowAccessStateValue()

Indicates whether the principal has the specified permission for the specified resource, based on evaluating all applicable IAM allow policies.

.google.cloud.policytroubleshooter.iam.v3.AllowAccessState allow_access_state = 1;

Returns
Type Description
int

The enum numeric value on the wire for allowAccessState.

getDefaultInstanceForType()

public AllowPolicyExplanation getDefaultInstanceForType()
Returns
Type Description
AllowPolicyExplanation

getExplainedPolicies(int index)

public ExplainedAllowPolicy getExplainedPolicies(int index)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameter
Name Description
index int
Returns
Type Description
ExplainedAllowPolicy

getExplainedPoliciesCount()

public int getExplainedPoliciesCount()

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Returns
Type Description
int

getExplainedPoliciesList()

public List<ExplainedAllowPolicy> getExplainedPoliciesList()

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Returns
Type Description
List<ExplainedAllowPolicy>

getExplainedPoliciesOrBuilder(int index)

public ExplainedAllowPolicyOrBuilder getExplainedPoliciesOrBuilder(int index)

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

Parameter
Name Description
index int
Returns
Type Description
ExplainedAllowPolicyOrBuilder

getExplainedPoliciesOrBuilderList()

public List<? extends ExplainedAllowPolicyOrBuilder> getExplainedPoliciesOrBuilderList()

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

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

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

repeated .google.cloud.policytroubleshooter.iam.v3.ExplainedAllowPolicy explained_policies = 2;

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

getParserForType()

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

getRelevance()

public HeuristicRelevance getRelevance()

The relevance of the allow policy type 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 allow policy type 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 AllowPolicyExplanation.Builder newBuilderForType()
Returns
Type Description
AllowPolicyExplanation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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