Class Explanations.ExplainedPolicy (1.11.0)

Version 1.11.0

• 1.52.0 (latest)
• 1.51.0
• 1.50.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.6
• 1.1.0
• 1.0.4
• 0.4.4

public static final class Explanations.ExplainedPolicy extends GeneratedMessageV3 implements Explanations.ExplainedPolicyOrBuilder

Details about how a specific IAM Policy contributed to the access check.

Protobuf type google.cloud.policytroubleshooter.v1.ExplainedPolicy

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Explanations.ExplainedPolicy

Implements

Explanations.ExplainedPolicyOrBuilder

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)

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)

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)

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

ACCESS_FIELD_NUMBER

public static final int ACCESS_FIELD_NUMBER

Field Value

Type	Description
int

BINDING_EXPLANATIONS_FIELD_NUMBER

public static final int BINDING_EXPLANATIONS_FIELD_NUMBER

Field Value

Type	Description
int

FULL_RESOURCE_NAME_FIELD_NUMBER

public static final int FULL_RESOURCE_NAME_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

Static Methods

getDefaultInstance()

public static Explanations.ExplainedPolicy getDefaultInstance()

Returns

Type	Description
Explanations.ExplainedPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static Explanations.ExplainedPolicy.Builder newBuilder()

Returns

Type	Description
Explanations.ExplainedPolicy.Builder

newBuilder(Explanations.ExplainedPolicy prototype)

public static Explanations.ExplainedPolicy.Builder newBuilder(Explanations.ExplainedPolicy prototype)

Parameter

Name	Description
prototype	Explanations.ExplainedPolicy

Returns

Type	Description
Explanations.ExplainedPolicy.Builder

parseDelimitedFrom(InputStream input)

public static Explanations.ExplainedPolicy parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Explanations.ExplainedPolicy

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Explanations.ExplainedPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Explanations.ExplainedPolicy

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static Explanations.ExplainedPolicy parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
Explanations.ExplainedPolicy

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Explanations.ExplainedPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Explanations.ExplainedPolicy

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Explanations.ExplainedPolicy parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
Explanations.ExplainedPolicy

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Explanations.ExplainedPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Explanations.ExplainedPolicy

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Explanations.ExplainedPolicy parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
Explanations.ExplainedPolicy

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Explanations.ExplainedPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Explanations.ExplainedPolicy

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static Explanations.ExplainedPolicy parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Explanations.ExplainedPolicy

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Explanations.ExplainedPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Explanations.ExplainedPolicy

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static Explanations.ExplainedPolicy parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
Explanations.ExplainedPolicy

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Explanations.ExplainedPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Explanations.ExplainedPolicy

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Explanations.ExplainedPolicy> parser()

Returns

Type	Description
Parser<ExplainedPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAccess()

public Explanations.AccessState getAccess()

Indicates whether this policy provides the specified permission to the specified member for the specified resource. This field does not indicate whether the member actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the member actually has the permission, use the access field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.v1.AccessState access = 1;

Returns

Type	Description
Explanations.AccessState	The access.

getAccessValue()

public int getAccessValue()

Indicates whether this policy provides the specified permission to the specified member for the specified resource. This field does not indicate whether the member actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the member actually has the permission, use the access field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.v1.AccessState access = 1;

Returns

Type	Description
int	The enum numeric value on the wire for access.

getBindingExplanations(int index)

public Explanations.BindingExplanation getBindingExplanations(int index)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameter

Name	Description
index	int

Returns

Type	Description
Explanations.BindingExplanation

getBindingExplanationsCount()

public int getBindingExplanationsCount()

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Returns

Type	Description
int

getBindingExplanationsList()

public List<Explanations.BindingExplanation> getBindingExplanationsList()

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Returns

Type	Description
List<BindingExplanation>

getBindingExplanationsOrBuilder(int index)

public Explanations.BindingExplanationOrBuilder getBindingExplanationsOrBuilder(int index)

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Parameter

Name	Description
index	int

Returns

Type	Description
Explanations.BindingExplanationOrBuilder

getBindingExplanationsOrBuilderList()

public List<? extends Explanations.BindingExplanationOrBuilder> getBindingExplanationsOrBuilderList()

Details about how each binding in the policy affects the member's ability, or inability, to use the permission for the resource. If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.v1.BindingExplanation binding_explanations = 4;

Returns

Type	Description
List<? extends google.cloud.policytroubleshooter.v1.Explanations.BindingExplanationOrBuilder>

getDefaultInstanceForType()

public Explanations.ExplainedPolicy getDefaultInstanceForType()

Returns

Type	Description
Explanations.ExplainedPolicy

getFullResourceName()

public String getFullResourceName()

The full resource name that identifies the resource. For example, //compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.

string full_resource_name = 2;

Returns

Type	Description
String	The fullResourceName.

getFullResourceNameBytes()

public ByteString getFullResourceNameBytes()

The full resource name that identifies the resource. For example, //compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.

string full_resource_name = 2;

Returns

Type	Description
ByteString	The bytes for fullResourceName.

getParserForType()

public Parser<Explanations.ExplainedPolicy> getParserForType()

Returns

Type	Description
Parser<ExplainedPolicy>

Overrides

GeneratedMessageV3.getParserForType()

getPolicy()

public Policy getPolicy()

The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.

.google.iam.v1.Policy policy = 3;

Returns

Type	Description
com.google.iam.v1.Policy	The policy.

getPolicyOrBuilder()

public PolicyOrBuilder getPolicyOrBuilder()

The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.

.google.iam.v1.Policy policy = 3;

Returns

Type	Description
com.google.iam.v1.PolicyOrBuilder

getRelevance()

public Explanations.HeuristicRelevance getRelevance()

The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.

.google.cloud.policytroubleshooter.v1.HeuristicRelevance relevance = 5;

Returns

Type	Description
Explanations.HeuristicRelevance	The relevance.

getRelevanceValue()

public int getRelevanceValue()

The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.

.google.cloud.policytroubleshooter.v1.HeuristicRelevance relevance = 5;

Returns

Type	Description
int	The enum numeric value on the wire for relevance.

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hasPolicy()

public boolean hasPolicy()

The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.

.google.iam.v1.Policy policy = 3;

Returns

Type	Description
boolean	Whether the policy field is set.

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 Explanations.ExplainedPolicy.Builder newBuilderForType()

Returns

Type	Description
Explanations.ExplainedPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Explanations.ExplainedPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
Explanations.ExplainedPolicy.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 Explanations.ExplainedPolicy.Builder toBuilder()

Returns

Type	Description
Explanations.ExplainedPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException