Google Cloud Policy Simulator V1 Client - Class ExplainedPolicy (0.1.1)

Reference documentation and code samples for the Google Cloud Policy Simulator V1 Client class ExplainedPolicy.

Details about how a specific IAM Policy contributed to the access check.

Generated from protobuf message google.cloud.policysimulator.v1.ExplainedPolicy

Namespace

Google \ Cloud \ PolicySimulator \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ access int

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.

↳ full_resource_name string

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.

↳ policy Google\Cloud\Iam\V1\Policy

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.

↳ binding_explanations array<Google\Cloud\PolicySimulator\V1\BindingExplanation>

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.

↳ relevance int

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.

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.

Returns
TypeDescription
int

setAccess

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

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.

Returns
TypeDescription
string

setFullResourceName

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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.

Returns
TypeDescription
Google\Cloud\Iam\V1\Policy|null

hasPolicy

clearPolicy

setPolicy

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.

Parameter
NameDescription
var Google\Cloud\Iam\V1\Policy
Returns
TypeDescription
$this

getBindingExplanations

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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setBindingExplanations

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.

Parameter
NameDescription
var array<Google\Cloud\PolicySimulator\V1\BindingExplanation>
Returns
TypeDescription
$this

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.

Returns
TypeDescription
int

setRelevance

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this