Reference documentation and code samples for the Google Cloud Policy Simulator V1 Client class AccessTuple.
Information about the principal, resource, and permission to check.
Generated from protobuf message google.cloud.policysimulator.v1.AccessTuple
Namespace
Google \ Cloud \ PolicySimulator \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ principal |
string
Required. The principal whose access you want to check, in the form of the email address that represents that principal. For example, |
↳ full_resource_name |
string
Required. The full resource name that identifies the resource. For example, |
↳ permission |
string
Required. The IAM permission to check for the specified principal and resource. For a complete list of IAM permissions, see https://cloud.google.com/iam/help/permissions/reference. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference. |
getPrincipal
Required. The principal whose access you want to check, in the form of
the email address that represents that principal. For example,
alice@example.com
or
my-service-account@my-project.iam.gserviceaccount.com
.
The principal must be a Google Account or a service account. Other types of principals are not supported.
Returns | |
---|---|
Type | Description |
string |
setPrincipal
Required. The principal whose access you want to check, in the form of
the email address that represents that principal. For example,
alice@example.com
or
my-service-account@my-project.iam.gserviceaccount.com
.
The principal must be a Google Account or a service account. Other types of principals are not supported.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFullResourceName
Required. The full resource name that identifies the resource. For example,
//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance
.
For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
Returns | |
---|---|
Type | Description |
string |
setFullResourceName
Required. The full resource name that identifies the resource. For example,
//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance
.
For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPermission
Required. The IAM permission to check for the specified principal and resource.
For a complete list of IAM permissions, see https://cloud.google.com/iam/help/permissions/reference. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.
Returns | |
---|---|
Type | Description |
string |
setPermission
Required. The IAM permission to check for the specified principal and resource.
For a complete list of IAM permissions, see https://cloud.google.com/iam/help/permissions/reference. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |