Class AllowPolicyExplanation (1.46.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AllowPolicyExplanation

Implements

AllowPolicyExplanationOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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.

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.

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.

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.

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

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public AllowPolicyExplanation.Builder toBuilder()

Returns
Type	Description
`AllowPolicyExplanation.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`