Reference documentation and code samples for the Policy Simulator V1 API class Google::Cloud::PolicySimulator::V1::AccessTuple.
Information about the principal, resource, and permission to check.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#full_resource_name
deffull_resource_name()->::String
Returns
(::String) — 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.
#full_resource_name=
deffull_resource_name=(value)->::String
Parameter
value (::String) — 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
(::String) — 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.
#permission
defpermission()->::String
Returns
(::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.
#permission=
defpermission=(value)->::String
Parameter
value (::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.
Returns
(::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.
#principal
defprincipal()->::String
Returns
(::String) — 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.
#principal=
defprincipal=(value)->::String
Parameter
value (::String) — 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
(::String) — 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[],[],null,["# Policy Simulator V1 API - Class Google::Cloud::PolicySimulator::V1::AccessTuple (v1.4.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.0 (latest)](/ruby/docs/reference/google-cloud-policy_simulator-v1/latest/Google-Cloud-PolicySimulator-V1-AccessTuple)\n- [1.3.0](/ruby/docs/reference/google-cloud-policy_simulator-v1/1.3.0/Google-Cloud-PolicySimulator-V1-AccessTuple)\n- [1.2.1](/ruby/docs/reference/google-cloud-policy_simulator-v1/1.2.1/Google-Cloud-PolicySimulator-V1-AccessTuple)\n- [1.1.0](/ruby/docs/reference/google-cloud-policy_simulator-v1/1.1.0/Google-Cloud-PolicySimulator-V1-AccessTuple)\n- [1.0.1](/ruby/docs/reference/google-cloud-policy_simulator-v1/1.0.1/Google-Cloud-PolicySimulator-V1-AccessTuple)\n- [0.4.0](/ruby/docs/reference/google-cloud-policy_simulator-v1/0.4.0/Google-Cloud-PolicySimulator-V1-AccessTuple)\n- [0.3.2](/ruby/docs/reference/google-cloud-policy_simulator-v1/0.3.2/Google-Cloud-PolicySimulator-V1-AccessTuple)\n- [0.2.0](/ruby/docs/reference/google-cloud-policy_simulator-v1/0.2.0/Google-Cloud-PolicySimulator-V1-AccessTuple)\n- [0.1.1](/ruby/docs/reference/google-cloud-policy_simulator-v1/0.1.1/Google-Cloud-PolicySimulator-V1-AccessTuple) \nReference documentation and code samples for the Policy Simulator V1 API class Google::Cloud::PolicySimulator::V1::AccessTuple.\n\nInformation about the principal, resource, and permission to check. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #full_resource_name\n\n def full_resource_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`.\n\n\n For examples of full resource names for Google Cloud services, see\n https://cloud.google.com/iam/help/troubleshooter/full-resource-names.\n\n### #full_resource_name=\n\n def full_resource_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`.\n\n\n For examples of full resource names for Google Cloud services, see\nhttps://cloud.google.com/iam/help/troubleshooter/full-resource-names. \n**Returns**\n\n- (::String) --- Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`.\n\n\n For examples of full resource names for Google Cloud services, see\n https://cloud.google.com/iam/help/troubleshooter/full-resource-names.\n\n### #permission\n\n def permission() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The IAM permission to check for the specified principal and resource.\n\n For a complete list of IAM permissions, see\n https://cloud.google.com/iam/help/permissions/reference.\n\n For a complete list of predefined IAM roles and the permissions in each\n role, see https://cloud.google.com/iam/help/roles/reference.\n\n### #permission=\n\n def permission=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The IAM permission to check for the specified principal and resource.\n\n\n For a complete list of IAM permissions, see\n https://cloud.google.com/iam/help/permissions/reference.\n\n For a complete list of predefined IAM roles and the permissions in each\nrole, see https://cloud.google.com/iam/help/roles/reference. \n**Returns**\n\n- (::String) --- Required. The IAM permission to check for the specified principal and resource.\n\n For a complete list of IAM permissions, see\n https://cloud.google.com/iam/help/permissions/reference.\n\n For a complete list of predefined IAM roles and the permissions in each\n role, see https://cloud.google.com/iam/help/roles/reference.\n\n### #principal\n\n def principal() -\u003e ::String\n\n**Returns**\n\n- (::String) --- 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`.\n\n\n The principal must be a Google Account or a service account. Other types of\n principals are not supported.\n\n### #principal=\n\n def principal=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- 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`.\n\n\n The principal must be a Google Account or a service account. Other types of\nprincipals are not supported. \n**Returns**\n\n- (::String) --- 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`.\n\n\n The principal must be a Google Account or a service account. Other types of\n principals are not supported."]]
