Google Cloud Policy Troubleshooter V1 Client - Class BindingExplanation (1.0.4)

Reference documentation and code samples for the Google Cloud Policy Troubleshooter V1 Client class BindingExplanation.

Details about how a binding in a policy affects a member's ability to use a permission.

Generated from protobuf message google.cloud.policytroubleshooter.v1.BindingExplanation

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ access int

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

↳ role string

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.

↳ role_permission int

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

↳ role_permission_relevance int

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

↳ memberships array|Google\Protobuf\Internal\MapField

Indicates whether each member in the binding includes the member specified in the request, either directly or indirectly. Each key identifies a member in the binding, and each value indicates whether the member in the binding includes the member in the request. For example, suppose that a binding includes the following members: * user:alice@example.com * group:product-eng@example.com You want to troubleshoot access for user:bob@example.com. This user is a member of the group group:product-eng@example.com. For the first member in the binding, the key is user:alice@example.com, and the membership field in the value is set to MEMBERSHIP_NOT_INCLUDED. For the second member in the binding, the key is group:product-eng@example.com, and the membership field in the value is set to MEMBERSHIP_INCLUDED.

↳ relevance int

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

↳ condition Google\Type\Expr

A condition expression that prevents access unless the expression evaluates to true. To learn about IAM Conditions, see http://cloud.google.com/iam/help/conditions/overview.

getAccess

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

Returns
TypeDescription
int

setAccess

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

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.

Returns
TypeDescription
string

setRole

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRolePermission

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

Returns
TypeDescription
int

setRolePermission

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRolePermissionRelevance

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

Returns
TypeDescription
int

setRolePermissionRelevance

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMemberships

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

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

  • user:alice@example.com
  • group:product-eng@example.com You want to troubleshoot access for user:bob@example.com. This user is a member of the group group:product-eng@example.com. For the first member in the binding, the key is user:alice@example.com, and the membership field in the value is set to MEMBERSHIP_NOT_INCLUDED. For the second member in the binding, the key is group:product-eng@example.com, and the membership field in the value is set to MEMBERSHIP_INCLUDED.
Returns
TypeDescription
Google\Protobuf\Internal\MapField

setMemberships

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

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

  • user:alice@example.com
  • group:product-eng@example.com You want to troubleshoot access for user:bob@example.com. This user is a member of the group group:product-eng@example.com. For the first member in the binding, the key is user:alice@example.com, and the membership field in the value is set to MEMBERSHIP_NOT_INCLUDED. For the second member in the binding, the key is group:product-eng@example.com, and the membership field in the value is set to MEMBERSHIP_INCLUDED.
Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getRelevance

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

Returns
TypeDescription
int

setRelevance

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCondition

A condition expression that prevents access unless the expression evaluates to true.

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

Returns
TypeDescription
Google\Type\Expr|null

hasCondition

clearCondition

setCondition

A condition expression that prevents access unless the expression evaluates to true.

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

Parameter
NameDescription
var Google\Type\Expr
Returns
TypeDescription
$this