Types overview

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

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:[e-mail]" ] }, { "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:[e-mail]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [e-mail] from DATA_READ logging, and [e-mail] 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:[e-mail]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [e-mail] 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, [e-mail] . * serviceAccount:{emailid}: An email address that represents a service account. For example, [e-mail]. * group:{emailid}: An email address that represents a Google group. For example, [e-mail]. * deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, [e-mail]?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, [e-mail]?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, [e-mail]?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. Assigned by the server.
displayName	string The folder's display name. A folder's display name must be unique amongst its siblings, e.g. 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}])?.
lifecycleState	enum Output only. The lifecycle state of the folder. Updates to the lifecycle_state must be performed via DeleteFolder and UndeleteFolder.
Enum type. Can be one of the following:
LIFECYCLE_STATE_UNSPECIFIED	Unspecified state.
ACTIVE	The normal and active state.
DELETE_REQUESTED	The folder has been marked for deletion by the user.
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 via MoveFolder.

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.

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.

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 to reparent the folder under. Must be of the form folders/{folder_id} or organizations/{org_id}.

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.

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:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[e-mail]" ], "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:[e-mail] - group:[e-mail] - domain:google.com - serviceAccount:[e-mail] role: roles/resourcemanager.organizationAdmin - members: - user:[e-mail] 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:[e-mail], 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.

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.

SearchFoldersRequest

The request message for searching folders.

Fields
pageSize	integer (int32 format) Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.
pageToken	string Optional. A pagination token returned from a previous call to SearchFolders that indicates from where search should continue.
query	string Search criteria used to select the Folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, lifecycleState and parent, where the operators =, NOT, AND and OR can be used along with the suffix wildcard symbol *. The displayName field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. Some example queries are: * Query displayName=Test* returns Folder resources whose display name starts with "Test". * Query lifecycleState=ACTIVE returns Folder resources with lifecycleState set to ACTIVE. * Query parent=folders/123 returns Folder resources that have folders/123 as a parent resource. * Query parent=folders/123 AND lifecycleState=ACTIVE returns active Folder resources that have folders/123 as a parent resource. * Query displayName=\\"Test String\\" returns Folder resources with display names that include both "Test" and "String".

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.

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.

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.