Interface ExplainedPolicyOrBuilder (0.31.0)

public interface ExplainedPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAccess()

public abstract AccessState getAccess()

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 access field in the TroubleshootIamPolicyResponse.

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

Returns
Type Description
AccessState

The access.

getAccessValue()

public abstract int getAccessValue()

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 access field in the TroubleshootIamPolicyResponse.

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

Returns
Type Description
int

The enum numeric value on the wire for access.

getBindingExplanations(int index)

public abstract BindingExplanation getBindingExplanations(int index)

Details about how each binding in the policy affects the principal's ability, or inability, to use the permission for the resource.

If the user who created the Replay does not have access to the policy, this field is omitted.

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

Parameter
Name Description
index int
Returns
Type Description
BindingExplanation

getBindingExplanationsCount()

public abstract int getBindingExplanationsCount()

Details about how each binding in the policy affects the principal's ability, or inability, to use the permission for the resource.

If the user who created the Replay does not have access to the policy, this field is omitted.

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

Returns
Type Description
int

getBindingExplanationsList()

public abstract List<BindingExplanation> getBindingExplanationsList()

Details about how each binding in the policy affects the principal's ability, or inability, to use the permission for the resource.

If the user who created the Replay does not have access to the policy, this field is omitted.

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

Returns
Type Description
List<BindingExplanation>

getBindingExplanationsOrBuilder(int index)

public abstract BindingExplanationOrBuilder getBindingExplanationsOrBuilder(int index)

Details about how each binding in the policy affects the principal's ability, or inability, to use the permission for the resource.

If the user who created the Replay does not have access to the policy, this field is omitted.

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

Parameter
Name Description
index int
Returns
Type Description
BindingExplanationOrBuilder

getBindingExplanationsOrBuilderList()

public abstract List<? extends BindingExplanationOrBuilder> getBindingExplanationsOrBuilderList()

Details about how each binding in the policy affects the principal's ability, or inability, to use the permission for the resource.

If the user who created the Replay does not have access to the policy, this field is omitted.

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

Returns
Type Description
List<? extends com.google.cloud.policysimulator.v1.BindingExplanationOrBuilder>

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 user who created the Replay 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 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 user who created the Replay 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.

getPolicy()

public abstract Policy getPolicy()

The IAM policy attached to the resource.

If the user who created the Replay 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 abstract PolicyOrBuilder getPolicyOrBuilder()

The IAM policy attached to the resource.

If the user who created the Replay 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 abstract HeuristicRelevance getRelevance()

The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse.

If the user who created the Replay does not have access to the policy, this field is omitted.

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

Returns
Type Description
HeuristicRelevance

The relevance.

getRelevanceValue()

public abstract int getRelevanceValue()

The relevance of this policy to the overall determination in the TroubleshootIamPolicyResponse.

If the user who created the Replay does not have access to the policy, this field is omitted.

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

Returns
Type Description
int

The enum numeric value on the wire for relevance.

hasPolicy()

public abstract boolean hasPolicy()

The IAM policy attached to the resource.

If the user who created the Replay 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.