Types overview

AuditConfig

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Fields
auditLogConfigs[]

object (AuditLogConfig)

The configuration for logging of each type of permission.

service

string

Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.

AuditLogConfig

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Fields
exemptedMembers[]

string

Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

logType

enum

The log type that this config enables.

Enum type. Can be one of the following:
LOG_TYPE_UNSPECIFIED Default case. Should never be this.
ADMIN_READ Admin reads. Example: CloudIAM getIamPolicy
DATA_WRITE Data writes. Example: CloudSQL Users create
DATA_READ Data reads. Example: CloudSQL Users list

Binding

Associates members, or principals, with a role.
Fields
condition

object (Expr)

The condition that is associated with this binding. If the condition evaluates to true, then this binding applies to the current request. If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the IAM documentation.

members[]

string

Specifies the principals requesting access for a Cloud Platform resource. members can have the following values: * allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. * allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. * user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . * serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. * group:{emailid}: An email address that represents a Google group. For example, admins@example.com. * deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. * deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. * deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. * domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

role

string

Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.

CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation

Metadata describing a long running folder operation
Fields
destinationParent

string

The resource name of the folder or organization we are either creating the folder under or moving the folder to.

displayName

string

The display name of the folder.

operationType

enum

The type of this operation.

Enum type. Can be one of the following:
OPERATION_TYPE_UNSPECIFIED Operation type not specified.
CREATE A create folder operation.
MOVE A move folder operation.
sourceParent

string

The resource name of the folder's parent. Only applicable when the operation_type is MOVE.

CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation

Metadata describing a long running folder operation
Fields
destinationParent

string

The resource name of the folder or organization we are either creating the folder under or moving the folder to.

displayName

string

The display name of the folder.

operationType

enum

The type of this operation.

Enum type. Can be one of the following:
OPERATION_TYPE_UNSPECIFIED Operation type not specified.
CREATE A create folder operation.
MOVE A move folder operation.
sourceParent

string

The resource name of the folder's parent. Only applicable when the operation_type is MOVE.

CreateFolderMetadata

Metadata pertaining to the Folder creation process.
Fields
displayName

string

The display name of the folder.

parent

string

The resource name of the folder or organization we are creating the folder under.

CreateProjectMetadata

A status object which is used as the metadata field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.
Fields
createTime

string (Timestamp format)

Creation time of the project creation workflow.

gettable

boolean

True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete.

ready

boolean

True if the project creation process is complete.

Expr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Fields
description

string

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

expression

string

Textual representation of an expression in Common Expression Language syntax.

location

string

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

title

string

Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Folder

A folder in an organization's resource hierarchy, used to organize that organization's resources.
Fields
createTime

string (Timestamp format)

Output only. Timestamp when the folder was created.

deleteTime

string (Timestamp format)

Output only. Timestamp when the folder was requested to be deleted.

displayName

string

The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

etag

string

Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

name

string

Output only. The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".

parent

string

Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.

state

enum

Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.

Enum type. Can be one of the following:
STATE_UNSPECIFIED Unspecified state.
ACTIVE The normal and active state.
DELETE_REQUESTED The folder has been marked for deletion by the user.
updateTime

string (Timestamp format)

Output only. Timestamp when the folder was last modified.

FolderOperation

Metadata describing a long running folder operation
Fields
destinationParent

string

The resource name of the folder or organization we are either creating the folder under or moving the folder to.

displayName

string

The display name of the folder.

operationType

enum

The type of this operation.

Enum type. Can be one of the following:
OPERATION_TYPE_UNSPECIFIED Operation type not specified.
CREATE A create folder operation.
MOVE A move folder operation.
sourceParent

string

The resource name of the folder's parent. Only applicable when the operation_type is MOVE.

FolderOperationError

A classification of the Folder Operation error.
Fields
errorMessageId

enum

The type of operation error experienced.

Enum type. Can be one of the following:
ERROR_TYPE_UNSPECIFIED The error type was unrecognized or unspecified.
ACTIVE_FOLDER_HEIGHT_VIOLATION The attempted action would violate the max folder depth constraint.
MAX_CHILD_FOLDERS_VIOLATION The attempted action would violate the max child folders constraint.
FOLDER_NAME_UNIQUENESS_VIOLATION The attempted action would violate the locally-unique folder display_name constraint.
RESOURCE_DELETED_VIOLATION The resource being moved has been deleted.
PARENT_DELETED_VIOLATION The resource a folder was being added to has been deleted.
CYCLE_INTRODUCED_VIOLATION The attempted action would introduce cycle in resource path.
FOLDER_BEING_MOVED_VIOLATION The attempted action would move a folder that is already being moved.
FOLDER_TO_DELETE_NON_EMPTY_VIOLATION The folder the caller is trying to delete contains active resources.
DELETED_FOLDER_HEIGHT_VIOLATION The attempted action would violate the max deleted folder depth constraint.

GetIamPolicyRequest

Request message for GetIamPolicy method.
Fields
options

object (GetPolicyOptions)

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

GetPolicyOptions

Encapsulates settings provided to GetIamPolicy.
Fields
requestedPolicyVersion

integer (int32 format)

Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

Lien

A Lien represents an encumbrance on the actions that can be performed on a resource.
Fields
createTime

string (Timestamp format)

The creation time of this Lien.

name

string

A system-generated unique identifier for this Lien. Example: liens/1234abcd

origin

string

A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: 'compute.googleapis.com'

parent

string

A reference to the resource this Lien is attached to. The server will validate the parent against those for which Liens are supported. Example: projects/1234

reason

string

Concise user-visible strings indicating why an action cannot be performed on a resource. Maximum length of 200 characters. Example: 'Holds production API key'

restrictions[]

string

The types of operations which should be blocked as a result of this Lien. Each value should correspond to an IAM permission. The server will validate the permissions against those for which Liens are supported. An empty list is meaningless and will be rejected. Example: ['resourcemanager.projects.delete']

ListFoldersResponse

The ListFolders response message.
Fields
folders[]

object (Folder)

A possibly paginated list of folders that are direct descendants of the specified parent resource.

nextPageToken

string

A pagination token returned from a previous call to ListFolders that indicates from where listing should continue.

ListLiensResponse

The response message for Liens.ListLiens.
Fields
liens[]

object (Lien)

A list of Liens.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

ListProjectsResponse

A page of the response received from the ListProjects method. A paginated response where more pages are available has next_page_token set. This token can be used in a subsequent request to retrieve the next request page. NOTE: A response may contain fewer elements than the request page_size and still have a next_page_token.
Fields
nextPageToken

string

Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the page_token parameter gives the next page of the results. When next_page_token is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.

projects[]

object (Project)

The list of Projects under the parent. This list can be paginated.

ListTagBindingsResponse

The ListTagBindings response.
Fields
nextPageToken

string

Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the page_token parameter gives the next page of the results. When next_page_token is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.

tagBindings[]

object (TagBinding)

A possibly paginated list of TagBindings for the specified resource.

ListTagKeysResponse

The ListTagKeys response message.
Fields
nextPageToken

string

A pagination token returned from a previous call to ListTagKeys that indicates from where listing should continue.

tagKeys[]

object (TagKey)

List of TagKeys that live under the specified parent in the request.

ListTagValuesResponse

The ListTagValues response.
Fields
nextPageToken

string

A pagination token returned from a previous call to ListTagValues that indicates from where listing should continue. This is currently not used, but the server may at any point start supplying a valid token.

tagValues[]

object (TagValue)

A possibly paginated list of TagValues that are direct descendants of the specified parent TagKey.

MoveFolderMetadata

Metadata pertaining to the folder move process.
Fields
destinationParent

string

The resource name of the folder or organization to move the folder to.

displayName

string

The display name of the folder.

sourceParent

string

The resource name of the folder's parent.

MoveFolderRequest

The MoveFolder request message.
Fields
destinationParent

string

Required. The resource name of the folder or organization which should be the folder's new parent. Must be of the form folders/{folder_id} or organizations/{org_id}.

MoveProjectRequest

The request sent to MoveProject method.
Fields
destinationParent

string

Required. The new parent to move the Project under.

Operation

This resource represents a long-running operation that is the result of a network API call.
Fields
done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

error

object (Status)

The error result of the operation in case of failure or cancellation.

metadata

map (key: string, value: any)

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

name

string

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

response

map (key: string, value: any)

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Organization

The root node in the resource hierarchy to which a particular entity's (a company, for example) resources belong.
Fields
createTime

string (Timestamp format)

Output only. Timestamp when the Organization was created.

deleteTime

string (Timestamp format)

Output only. Timestamp when the Organization was requested for deletion.

directoryCustomerId

string

Immutable. The G Suite / Workspace customer id used in the Directory API.

displayName

string

Output only. A human-readable string that refers to the organization in the Google Cloud Console. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, "google.com") of the Google Workspace customer that owns the organization.

etag

string

Output only. A checksum computed by the server based on the current value of the Organization resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

name

string

Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".

state

enum

Output only. The organization's current lifecycle state.

Enum type. Can be one of the following:
STATE_UNSPECIFIED Unspecified state. This is only useful for distinguishing unset values.
ACTIVE The normal and active state.
DELETE_REQUESTED The organization has been marked for deletion by the user.
updateTime

string (Timestamp format)

Output only. Timestamp when the Organization was last modified.

Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.
Fields
auditConfigs[]

object (AuditConfig)

Specifies cloud audit logging configuration for this policy.

bindings[]

object (Binding)

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

etag

string (bytes format)

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

version

integer (int32 format)

Specifies the format of the policy. Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.

Project

A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.
Fields
createTime

string (Timestamp format)

Output only. Creation time.

deleteTime

string (Timestamp format)

Output only. The time at which this resource was requested for deletion.

displayName

string

Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project

etag

string

Output only. A checksum computed by the server based on the current value of the Project resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

labels

map (key: string, value: string)

Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9][a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9][a-z0-9])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "myBusinessDimension" : "businessValue"

name

string

Output only. The unique resource name of the project. It is an int64 generated number prefixed by "projects/". Example: projects/415104041262

parent

string

Optional. A reference to a parent Resource. eg., organizations/123 or folders/876.

projectId

string

Immutable. The unique, user-assigned id of the project. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123

state

enum

Output only. The project lifecycle state.

Enum type. Can be one of the following:
STATE_UNSPECIFIED Unspecified state. This is only used/useful for distinguishing unset values.
ACTIVE The normal and active state.
DELETE_REQUESTED The project has been marked for deletion by the user (by invoking DeleteProject) or by the system (Google Cloud Platform). This can generally be reversed by invoking UndeleteProject.
updateTime

string (Timestamp format)

Output only. The most recent time this resource was modified.

ProjectCreationStatus

A status object which is used as the metadata field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.
Fields
createTime

string (Timestamp format)

Creation time of the project creation workflow.

gettable

boolean

True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete.

ready

boolean

True if the project creation process is complete.

SearchFoldersResponse

The response message for searching folders.
Fields
folders[]

object (Folder)

A possibly paginated folder search results. the specified parent resource.

nextPageToken

string

A pagination token returned from a previous call to SearchFolders that indicates from where searching should continue.

SearchOrganizationsResponse

The response returned from the SearchOrganizations method.
Fields
nextPageToken

string

A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results.

organizations[]

object (Organization)

The list of Organizations that matched the search query, possibly paginated.

SearchProjectsResponse

A page of the response received from the SearchProjects method. A paginated response where more pages are available has next_page_token set. This token can be used in a subsequent request to retrieve the next request page.
Fields
nextPageToken

string

Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the page_token parameter gives the next page of the results. When next_page_token is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.

projects[]

object (Project)

The list of Projects that matched the list filter query. This list can be paginated.

SetIamPolicyRequest

Request message for SetIamPolicy method.
Fields
policy

object (Policy)

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

updateMask

string (FieldMask format)

OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag"

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Fields
code

integer (int32 format)

The status code, which should be an enum value of google.rpc.Code.

details[]

object

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message

string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

TagBinding

A TagBinding represents a connection between a TagValue and a cloud resource (currently project, folder, or organization). Once a TagBinding is created, the TagValue is applied to all the descendants of the cloud resource.
Fields
name

string

Output only. The name of the TagBinding. This is a String of the form: tagBindings/{full-resource-name}/{tag-value-name} (e.g. tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456).

parent

string

The full resource name of the resource the TagValue is bound to. E.g. //cloudresourcemanager.googleapis.com/projects/123

tagValue

string

The TagValue of the TagBinding. Must be of the form tagValues/456.

TagKey

A TagKey, used to group a set of TagValues.
Fields
createTime

string (Timestamp format)

Output only. Creation time.

description

string

Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.

etag

string

Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.

name

string

Immutable. The resource name for a TagKey. Must be in the format tagKeys/{tag_key_id}, where tag_key_id is the generated numeric id for the TagKey.

namespacedName

string

Output only. Immutable. Namespaced name of the TagKey.

parent

string

Immutable. The resource name of the new TagKey's parent. Must be of the form organizations/{org_id}.

shortName

string

Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

updateTime

string (Timestamp format)

Output only. Update time.

TagValue

A TagValue is a child of a particular TagKey. This is used to group cloud resources for the purpose of controlling them using policies.
Fields
createTime

string (Timestamp format)

Output only. Creation time.

description

string

Optional. User-assigned description of the TagValue. Must not exceed 256 characters. Read-write.

etag

string

Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagValueRequest for details.

name

string

Immutable. Resource name for TagValue in the format tagValues/456.

namespacedName

string

Output only. Namespaced name of the TagValue. Must be in the format {organization_id}/{tag_key_short_name}/{short_name}.

parent

string

Immutable. The resource name of the new TagValue's parent TagKey. Must be of the form tagKeys/{tag_key_id}.

shortName

string

Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

updateTime

string (Timestamp format)

Output only. Update time.

TestIamPermissionsRequest

Request message for TestIamPermissions method.
Fields
permissions[]

string

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

TestIamPermissionsResponse

Response message for TestIamPermissions method.
Fields
permissions[]

string

A subset of TestPermissionsRequest.permissions that the caller is allowed.