Interface Explanations.BindingExplanationOrBuilder (1.30.0)

Version 1.30.0

• 1.54.0 (latest)
• 1.53.0
• 1.52.0
• 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 interface Explanations.BindingExplanationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMemberships(String key)

public abstract boolean containsMemberships(String key)

Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the binding, and each value indicates whether the principal in the binding includes the principal in the request.

For example, suppose that a binding includes the following principals:

• user:[e-mail]

• group:[e-mail]

  You want to troubleshoot access for user:[e-mail]. This user is a principal of the group group:[e-mail].

  For the first principal in the binding, the key is user:[e-mail], and the membership field in the value is set to MEMBERSHIP_NOT_INCLUDED.

  For the second principal in the binding, the key is group:[e-mail], and the membership field in the value is set to MEMBERSHIP_INCLUDED.

map<string, .google.cloud.policytroubleshooter.v1.BindingExplanation.AnnotatedMembership> memberships = 5;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAccess()

public abstract Explanations.AccessState getAccess()

Required. Indicates whether this binding 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 binding that overrides this binding. To determine whether the principal actually has the permission, use the access field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.v1.AccessState access = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Explanations.AccessState	The access.

getAccessValue()

public abstract int getAccessValue()

Required. Indicates whether this binding 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 binding that overrides this binding. To determine whether the principal actually has the permission, use the access field in the TroubleshootIamPolicyResponse.

.google.cloud.policytroubleshooter.v1.AccessState access = 1 [(.google.api.field_behavior) = REQUIRED];

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

getCondition()

public abstract Expr getCondition()

A condition expression that prevents this binding from granting access unless the expression evaluates to true.

To learn about IAM Conditions, see https://cloud.google.com/iam/help/conditions/overview.

.google.type.Expr condition = 7;

Returns
Type	Description
com.google.type.Expr	The condition.

getConditionOrBuilder()

public abstract ExprOrBuilder getConditionOrBuilder()

A condition expression that prevents this binding from granting access unless the expression evaluates to true.

To learn about IAM Conditions, see https://cloud.google.com/iam/help/conditions/overview.

.google.type.Expr condition = 7;

Returns
Type	Description
com.google.type.ExprOrBuilder

getMemberships() (deprecated)

public abstract Map<String,Explanations.BindingExplanation.AnnotatedMembership> getMemberships()

Use #getMembershipsMap() instead.

Returns
Type	Description
Map<String,AnnotatedMembership>

getMembershipsCount()

public abstract int getMembershipsCount()

Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the binding, and each value indicates whether the principal in the binding includes the principal in the request.

For example, suppose that a binding includes the following principals:

• user:[e-mail]

• group:[e-mail]

  You want to troubleshoot access for user:[e-mail]. This user is a principal of the group group:[e-mail].

  For the first principal in the binding, the key is user:[e-mail], and the membership field in the value is set to MEMBERSHIP_NOT_INCLUDED.

  For the second principal in the binding, the key is group:[e-mail], and the membership field in the value is set to MEMBERSHIP_INCLUDED.

map<string, .google.cloud.policytroubleshooter.v1.BindingExplanation.AnnotatedMembership> memberships = 5;

Returns
Type	Description
int

getMembershipsMap()

public abstract Map<String,Explanations.BindingExplanation.AnnotatedMembership> getMembershipsMap()

Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the binding, and each value indicates whether the principal in the binding includes the principal in the request.

For example, suppose that a binding includes the following principals:

• user:[e-mail]

• group:[e-mail]

  You want to troubleshoot access for user:[e-mail]. This user is a principal of the group group:[e-mail].

  For the first principal in the binding, the key is user:[e-mail], and the membership field in the value is set to MEMBERSHIP_NOT_INCLUDED.

  For the second principal in the binding, the key is group:[e-mail], and the membership field in the value is set to MEMBERSHIP_INCLUDED.

map<string, .google.cloud.policytroubleshooter.v1.BindingExplanation.AnnotatedMembership> memberships = 5;

Returns
Type	Description
Map<String,AnnotatedMembership>

getMembershipsOrDefault(String key, Explanations.BindingExplanation.AnnotatedMembership defaultValue)

public abstract Explanations.BindingExplanation.AnnotatedMembership getMembershipsOrDefault(String key, Explanations.BindingExplanation.AnnotatedMembership defaultValue)

Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the binding, and each value indicates whether the principal in the binding includes the principal in the request.

For example, suppose that a binding includes the following principals:

• user:[e-mail]

• group:[e-mail]

  You want to troubleshoot access for user:[e-mail]. This user is a principal of the group group:[e-mail].

  For the first principal in the binding, the key is user:[e-mail], and the membership field in the value is set to MEMBERSHIP_NOT_INCLUDED.

  For the second principal in the binding, the key is group:[e-mail], and the membership field in the value is set to MEMBERSHIP_INCLUDED.

map<string, .google.cloud.policytroubleshooter.v1.BindingExplanation.AnnotatedMembership> memberships = 5;

Parameters
Name	Description
key	String
defaultValue	Explanations.BindingExplanation.AnnotatedMembership

Returns
Type	Description
Explanations.BindingExplanation.AnnotatedMembership

getMembershipsOrThrow(String key)

public abstract Explanations.BindingExplanation.AnnotatedMembership getMembershipsOrThrow(String key)

Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the binding, and each value indicates whether the principal in the binding includes the principal in the request.

For example, suppose that a binding includes the following principals:

• user:[e-mail]

• group:[e-mail]

  You want to troubleshoot access for user:[e-mail]. This user is a principal of the group group:[e-mail].

  For the first principal in the binding, the key is user:[e-mail], and the membership field in the value is set to MEMBERSHIP_NOT_INCLUDED.

  For the second principal in the binding, the key is group:[e-mail], and the membership field in the value is set to MEMBERSHIP_INCLUDED.

map<string, .google.cloud.policytroubleshooter.v1.BindingExplanation.AnnotatedMembership> memberships = 5;

Parameter
Name	Description
key	String

Returns
Type	Description
Explanations.BindingExplanation.AnnotatedMembership

getRelevance()

public abstract Explanations.HeuristicRelevance getRelevance()

The relevance of this binding to the overall determination for the entire policy.

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

Returns
Type	Description
Explanations.HeuristicRelevance	The relevance.

getRelevanceValue()

public abstract int getRelevanceValue()

The relevance of this binding to the overall determination for the entire policy.

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

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

getRole()

public abstract String getRole()

The role that this binding grants. For example, roles/compute.serviceAgent.

For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.

string role = 2;

Returns
Type	Description
String	The role.

getRoleBytes()

public abstract ByteString getRoleBytes()

The role that this binding grants. For example, roles/compute.serviceAgent.

For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.

string role = 2;

Returns
Type	Description
ByteString	The bytes for role.

getRolePermission()

public abstract Explanations.BindingExplanation.RolePermission getRolePermission()

Indicates whether the role granted by this binding contains the specified permission.

.google.cloud.policytroubleshooter.v1.BindingExplanation.RolePermission role_permission = 3;

Returns
Type	Description
Explanations.BindingExplanation.RolePermission	The rolePermission.

getRolePermissionRelevance()

public abstract Explanations.HeuristicRelevance getRolePermissionRelevance()

The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.

.google.cloud.policytroubleshooter.v1.HeuristicRelevance role_permission_relevance = 4;

Returns
Type	Description
Explanations.HeuristicRelevance	The rolePermissionRelevance.

getRolePermissionRelevanceValue()

public abstract int getRolePermissionRelevanceValue()

The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.

.google.cloud.policytroubleshooter.v1.HeuristicRelevance role_permission_relevance = 4;

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

getRolePermissionValue()

public abstract int getRolePermissionValue()

Indicates whether the role granted by this binding contains the specified permission.

.google.cloud.policytroubleshooter.v1.BindingExplanation.RolePermission role_permission = 3;

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

hasCondition()

public abstract boolean hasCondition()

A condition expression that prevents this binding from granting access unless the expression evaluates to true.

To learn about IAM Conditions, see https://cloud.google.com/iam/help/conditions/overview.

.google.type.Expr condition = 7;

Returns
Type	Description
boolean	Whether the condition field is set.