Class ExplainedAllowPolicy (1.45.0)

public final class ExplainedAllowPolicy extends GeneratedMessageV3 implements ExplainedAllowPolicyOrBuilder

Details about how a specific IAM allow policy contributed to the final access state.

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

Static Fields

ALLOW_ACCESS_STATE_FIELD_NUMBER

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

getDescriptor()

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

newBuilder()

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

newBuilder(ExplainedAllowPolicy prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAllowAccessState()

public AllowAccessState getAllowAccessState()

Required. Indicates whether this policy provides 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.AllowAccessState allow_access_state = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AllowAccessState

The allowAccessState.

getAllowAccessStateValue()

public int getAllowAccessStateValue()

Required. Indicates whether this policy provides 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.AllowAccessState allow_access_state = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for allowAccessState.

getBindingExplanations(int index)

public AllowBindingExplanation getBindingExplanations(int index)

Details about how each role binding in the policy affects the principal's ability, or inability, to use the permission for the resource. The order of the role bindings matches the role binding order in the policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.AllowBindingExplanation binding_explanations = 3;

Parameter
Name Description
index int
Returns
Type Description
AllowBindingExplanation

getBindingExplanationsCount()

public int getBindingExplanationsCount()

Details about how each role binding in the policy affects the principal's ability, or inability, to use the permission for the resource. The order of the role bindings matches the role binding order in the policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.AllowBindingExplanation binding_explanations = 3;

Returns
Type Description
int

getBindingExplanationsList()

public List<AllowBindingExplanation> getBindingExplanationsList()

Details about how each role binding in the policy affects the principal's ability, or inability, to use the permission for the resource. The order of the role bindings matches the role binding order in the policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.AllowBindingExplanation binding_explanations = 3;

Returns
Type Description
List<AllowBindingExplanation>

getBindingExplanationsOrBuilder(int index)

public AllowBindingExplanationOrBuilder getBindingExplanationsOrBuilder(int index)

Details about how each role binding in the policy affects the principal's ability, or inability, to use the permission for the resource. The order of the role bindings matches the role binding order in the policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.AllowBindingExplanation binding_explanations = 3;

Parameter
Name Description
index int
Returns
Type Description
AllowBindingExplanationOrBuilder

getBindingExplanationsOrBuilderList()

public List<? extends AllowBindingExplanationOrBuilder> getBindingExplanationsOrBuilderList()

Details about how each role binding in the policy affects the principal's ability, or inability, to use the permission for the resource. The order of the role bindings matches the role binding order in the policy.

If the sender of the request does not have access to the policy, this field is omitted.

repeated .google.cloud.policytroubleshooter.iam.v3.AllowBindingExplanation binding_explanations = 3;

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

getDefaultInstanceForType()

public ExplainedAllowPolicy getDefaultInstanceForType()
Returns
Type Description
ExplainedAllowPolicy

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<ExplainedAllowPolicy> getParserForType()
Returns
Type Description
Parser<ExplainedAllowPolicy>
Overrides

getPolicy()

public Policy getPolicy()

The IAM allow 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 = 5;

Returns
Type Description
com.google.iam.v1.Policy

The policy.

getPolicyOrBuilder()

public PolicyOrBuilder getPolicyOrBuilder()

The IAM allow 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 = 5;

Returns
Type Description
com.google.iam.v1.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
Type Description
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
Type Description
int

The enum numeric value on the wire for relevance.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasPolicy()

public boolean hasPolicy()

The IAM allow 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 = 5;

Returns
Type Description
boolean

Whether the policy field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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