Interface ExplainedAllowPolicyOrBuilder (1.35.0)

public interface ExplainedAllowPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllowAccessState()

public abstract 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
TypeDescription
AllowAccessState

The allowAccessState.

getAllowAccessStateValue()

public abstract 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
TypeDescription
int

The enum numeric value on the wire for allowAccessState.

getBindingExplanations(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
AllowBindingExplanation

getBindingExplanationsCount()

public abstract 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
TypeDescription
int

getBindingExplanationsList()

public abstract 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
TypeDescription
List<AllowBindingExplanation>

getBindingExplanationsOrBuilder(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
AllowBindingExplanationOrBuilder

getBindingExplanationsOrBuilderList()

public abstract 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
TypeDescription
List<? extends com.google.cloud.policytroubleshooter.iam.v3.AllowBindingExplanationOrBuilder>

getFullResourceName()

public abstract 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
TypeDescription
String

The fullResourceName.

getFullResourceNameBytes()

public abstract 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
TypeDescription
ByteString

The bytes for fullResourceName.

getPolicy()

public abstract 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
TypeDescription
com.google.iam.v1.Policy

The policy.

getPolicyOrBuilder()

public abstract 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
TypeDescription
com.google.iam.v1.PolicyOrBuilder

getRelevance()

public abstract 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
TypeDescription
HeuristicRelevance

The relevance.

getRelevanceValue()

public abstract 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
TypeDescription
int

The enum numeric value on the wire for relevance.

hasPolicy()

public abstract 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
TypeDescription
boolean

Whether the policy field is set.