Returns the workstations Resource.
Close httplib2 connections.
create(parent, body=None, validateOnly=None, workstationConfigId=None, x__xgafv=None)
Creates a new workstation configuration.
delete(name, etag=None, force=None, validateOnly=None, x__xgafv=None)
Deletes the specified workstation configuration.
Returns the requested workstation configuration.
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns all workstation configurations in the specified cluster.
listUsable(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
Retrieves the next page of results.
Retrieves the next page of results.
patch(name, allowMissing=None, body=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates an existing workstation configuration.
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
close()
Close httplib2 connections.
create(parent, body=None, validateOnly=None, workstationConfigId=None, x__xgafv=None)
Creates a new workstation configuration. Args: parent: string, Required. Parent resource name. (required) body: object, The request body. The object takes the form of: { # A set of configuration options describing how a workstation will be run. Workstation configurations are intended to be shared across multiple workstations. "annotations": { # Client-specified annotations. "a_key": "A String", }, "conditions": [ # Output only. Status conditions describing the current resource state. { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], "message": "A 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. }, ], "container": { # A Docker container. # Container that will be run for each workstation using this configuration when that workstation is started. "args": [ # Arguments passed to the entrypoint. "A String", ], "command": [ # If set, overrides the default ENTRYPOINT specified by the image. "A String", ], "env": { # Environment variables passed to the container. "a_key": "A String", }, "image": "A String", # Docker image defining the container. This image must be accessible by the config's service account. "runAsUser": 42, # If set, overrides the USER specified in the image with the given uid. "workingDir": "A String", # If set, overrides the default DIR specified by the image. }, "createTime": "A String", # Output only. Time when this resource was created. "degraded": True or False, # Output only. Whether this resource is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in the `conditions` field. "deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Encrypts resources of this workstation configuration using a customer-managed encryption key. If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost. If the encryption key is revoked, the workstation session will automatically be stopped within 7 hours. "kmsKey": "A String", # The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. "kmsKeyServiceAccount": "A String", # The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). }, "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. "host": { # Runtime host for a workstation. # Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "bootDiskSizeGb": 42, # Size of the boot disk in GB. "confidentialInstanceConfig": { # A set of Compute Engine Confidential VM instance options. # A set of Compute Engine Confidential VM instance options. "enableConfidentialCompute": True or False, # Whether the instance has confidential compute enabled. }, "disablePublicIpAddresses": True or False, # Whether instances have no public IP address. "machineType": "A String", # The name of a Compute Engine machine type. "poolSize": 42, # Number of instances to pool for faster workstation starup. "serviceAccount": "A String", # Email address of the service account that will be used on VM instances used to support this config. This service account must have permission to pull the specified container image. If not set, VMs will run without a service account, in which case the image must be publicly accessible. "shieldedInstanceConfig": { # A set of Compute Engine Shielded instance options. # A set of Compute Engine Shielded instance options. "enableIntegrityMonitoring": True or False, # Whether the instance has integrity monitoring enabled. "enableSecureBoot": True or False, # Whether the instance has Secure Boot enabled. "enableVtpm": True or False, # Whether the instance has the vTPM enabled. }, "tags": [ # Network tags to add to the Compute Engine machines backing the Workstations. "A String", ], }, }, "idleTimeout": "A String", # How long to wait before automatically stopping an instance that hasn't received any user traffic. A value of 0 indicates that this instance should never time out due to idleness. Defaults to 20 minutes. "labels": { # Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, "name": "A String", # Full name of this resource. "persistentDirectories": [ # Directories to persist across workstation sessions. { # A directory to persist across workstation sessions. "gcePd": { # A PersistentDirectory backed by a Compute Engine regional persistent disk. # A PersistentDirectory backed by a Compute Engine persistent disk. "diskType": "A String", # Type of the disk to use. "fsType": "A String", # Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. "reclaimPolicy": "A String", # What should happen to the disk after the workstation is deleted. Defaults to DELETE. "sizeGb": 42, # Size of the disk in GB. Must be empty if source_snapshot is set. "sourceSnapshot": "A String", # Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. }, "mountPath": "A String", # Location of this directory in the running workstation. }, ], "reconciling": True or False, # Output only. Indicates whether this resource is currently being updated to match its intended state. "runningTimeout": "A String", # How long to wait before automatically stopping a workstation after it started. A value of 0 indicates that workstations using this configuration should never time out. Must be greater than 0 and less than 24 hours if encryption_key is set. Defaults to 12 hours. "uid": "A String", # Output only. A system-assigned unique identified for this resource. "updateTime": "A String", # Output only. Time when this resource was most recently updated. } validateOnly: boolean, If set, validate the request and preview the review, but do not actually apply it. workstationConfigId: string, Required. ID to use for the config. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # This resource represents a long-running operation that is the result of a network API call. "done": True or False, # 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": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], "message": "A 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. }, "metadata": { # 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. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "name": "A 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": { # 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`. "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
delete(name, etag=None, force=None, validateOnly=None, x__xgafv=None)
Deletes the specified workstation configuration. Args: name: string, Required. Name of the config to delete. (required) etag: string, If set, the request will be rejected if the latest version of the config on the server does not have this etag. force: boolean, If set, any Workstations in the config will also be deleted. Otherwise, the request will work only if the config has no workstations. validateOnly: boolean, If set, validate the request and preview the review, but do not actually apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # This resource represents a long-running operation that is the result of a network API call. "done": True or False, # 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": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], "message": "A 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. }, "metadata": { # 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. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "name": "A 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": { # 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`. "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
get(name, x__xgafv=None)
Returns the requested workstation configuration. Args: name: string, Required. Name of the requested resource. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # A set of configuration options describing how a workstation will be run. Workstation configurations are intended to be shared across multiple workstations. "annotations": { # Client-specified annotations. "a_key": "A String", }, "conditions": [ # Output only. Status conditions describing the current resource state. { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], "message": "A 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. }, ], "container": { # A Docker container. # Container that will be run for each workstation using this configuration when that workstation is started. "args": [ # Arguments passed to the entrypoint. "A String", ], "command": [ # If set, overrides the default ENTRYPOINT specified by the image. "A String", ], "env": { # Environment variables passed to the container. "a_key": "A String", }, "image": "A String", # Docker image defining the container. This image must be accessible by the config's service account. "runAsUser": 42, # If set, overrides the USER specified in the image with the given uid. "workingDir": "A String", # If set, overrides the default DIR specified by the image. }, "createTime": "A String", # Output only. Time when this resource was created. "degraded": True or False, # Output only. Whether this resource is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in the `conditions` field. "deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Encrypts resources of this workstation configuration using a customer-managed encryption key. If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost. If the encryption key is revoked, the workstation session will automatically be stopped within 7 hours. "kmsKey": "A String", # The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. "kmsKeyServiceAccount": "A String", # The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). }, "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. "host": { # Runtime host for a workstation. # Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "bootDiskSizeGb": 42, # Size of the boot disk in GB. "confidentialInstanceConfig": { # A set of Compute Engine Confidential VM instance options. # A set of Compute Engine Confidential VM instance options. "enableConfidentialCompute": True or False, # Whether the instance has confidential compute enabled. }, "disablePublicIpAddresses": True or False, # Whether instances have no public IP address. "machineType": "A String", # The name of a Compute Engine machine type. "poolSize": 42, # Number of instances to pool for faster workstation starup. "serviceAccount": "A String", # Email address of the service account that will be used on VM instances used to support this config. This service account must have permission to pull the specified container image. If not set, VMs will run without a service account, in which case the image must be publicly accessible. "shieldedInstanceConfig": { # A set of Compute Engine Shielded instance options. # A set of Compute Engine Shielded instance options. "enableIntegrityMonitoring": True or False, # Whether the instance has integrity monitoring enabled. "enableSecureBoot": True or False, # Whether the instance has Secure Boot enabled. "enableVtpm": True or False, # Whether the instance has the vTPM enabled. }, "tags": [ # Network tags to add to the Compute Engine machines backing the Workstations. "A String", ], }, }, "idleTimeout": "A String", # How long to wait before automatically stopping an instance that hasn't received any user traffic. A value of 0 indicates that this instance should never time out due to idleness. Defaults to 20 minutes. "labels": { # Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, "name": "A String", # Full name of this resource. "persistentDirectories": [ # Directories to persist across workstation sessions. { # A directory to persist across workstation sessions. "gcePd": { # A PersistentDirectory backed by a Compute Engine regional persistent disk. # A PersistentDirectory backed by a Compute Engine persistent disk. "diskType": "A String", # Type of the disk to use. "fsType": "A String", # Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. "reclaimPolicy": "A String", # What should happen to the disk after the workstation is deleted. Defaults to DELETE. "sizeGb": 42, # Size of the disk in GB. Must be empty if source_snapshot is set. "sourceSnapshot": "A String", # Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. }, "mountPath": "A String", # Location of this directory in the running workstation. }, ], "reconciling": True or False, # Output only. Indicates whether this resource is currently being updated to match its intended state. "runningTimeout": "A String", # How long to wait before automatically stopping a workstation after it started. A value of 0 indicates that workstations using this configuration should never time out. Must be greater than 0 and less than 24 hours if encryption_key is set. Defaults to 12 hours. "uid": "A String", # Output only. A system-assigned unique identified for this resource. "updateTime": "A String", # Output only. Time when this resource was most recently updated. }
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. Args: resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) options_requestedPolicyVersion: integer, 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](https://cloud.google.com/iam/help/conditions/resource-policies). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # 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](https://cloud.google.com/iam/help/conditions/resource-policies). **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](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. { # 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. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # 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. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. "A String", ], "logType": "A String", # The log type that this config enables. }, ], "service": "A 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. }, ], "bindings": [ # 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`. { # Associates `members`, or principals, with a `role`. "condition": { # 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. # 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](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A 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": "A String", # Textual representation of an expression in Common Expression Language syntax. "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. "title": "A 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. }, "members": [ # Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. }, ], "etag": "A String", # `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": 42, # 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](https://cloud.google.com/iam/help/conditions/resource-policies). }
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns all workstation configurations in the specified cluster. Args: parent: string, Required. Parent resource name. (required) pageSize: integer, Maximum number of items to return. pageToken: string, next_page_token value returned from a previous List request, if any. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Response message for ListWorkstationConfigs. "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. "unreachable": [ # Unreachable resources. "A String", ], "workstationConfigs": [ # The requested configs. { # A set of configuration options describing how a workstation will be run. Workstation configurations are intended to be shared across multiple workstations. "annotations": { # Client-specified annotations. "a_key": "A String", }, "conditions": [ # Output only. Status conditions describing the current resource state. { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], "message": "A 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. }, ], "container": { # A Docker container. # Container that will be run for each workstation using this configuration when that workstation is started. "args": [ # Arguments passed to the entrypoint. "A String", ], "command": [ # If set, overrides the default ENTRYPOINT specified by the image. "A String", ], "env": { # Environment variables passed to the container. "a_key": "A String", }, "image": "A String", # Docker image defining the container. This image must be accessible by the config's service account. "runAsUser": 42, # If set, overrides the USER specified in the image with the given uid. "workingDir": "A String", # If set, overrides the default DIR specified by the image. }, "createTime": "A String", # Output only. Time when this resource was created. "degraded": True or False, # Output only. Whether this resource is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in the `conditions` field. "deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Encrypts resources of this workstation configuration using a customer-managed encryption key. If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost. If the encryption key is revoked, the workstation session will automatically be stopped within 7 hours. "kmsKey": "A String", # The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. "kmsKeyServiceAccount": "A String", # The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). }, "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. "host": { # Runtime host for a workstation. # Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "bootDiskSizeGb": 42, # Size of the boot disk in GB. "confidentialInstanceConfig": { # A set of Compute Engine Confidential VM instance options. # A set of Compute Engine Confidential VM instance options. "enableConfidentialCompute": True or False, # Whether the instance has confidential compute enabled. }, "disablePublicIpAddresses": True or False, # Whether instances have no public IP address. "machineType": "A String", # The name of a Compute Engine machine type. "poolSize": 42, # Number of instances to pool for faster workstation starup. "serviceAccount": "A String", # Email address of the service account that will be used on VM instances used to support this config. This service account must have permission to pull the specified container image. If not set, VMs will run without a service account, in which case the image must be publicly accessible. "shieldedInstanceConfig": { # A set of Compute Engine Shielded instance options. # A set of Compute Engine Shielded instance options. "enableIntegrityMonitoring": True or False, # Whether the instance has integrity monitoring enabled. "enableSecureBoot": True or False, # Whether the instance has Secure Boot enabled. "enableVtpm": True or False, # Whether the instance has the vTPM enabled. }, "tags": [ # Network tags to add to the Compute Engine machines backing the Workstations. "A String", ], }, }, "idleTimeout": "A String", # How long to wait before automatically stopping an instance that hasn't received any user traffic. A value of 0 indicates that this instance should never time out due to idleness. Defaults to 20 minutes. "labels": { # Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, "name": "A String", # Full name of this resource. "persistentDirectories": [ # Directories to persist across workstation sessions. { # A directory to persist across workstation sessions. "gcePd": { # A PersistentDirectory backed by a Compute Engine regional persistent disk. # A PersistentDirectory backed by a Compute Engine persistent disk. "diskType": "A String", # Type of the disk to use. "fsType": "A String", # Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. "reclaimPolicy": "A String", # What should happen to the disk after the workstation is deleted. Defaults to DELETE. "sizeGb": 42, # Size of the disk in GB. Must be empty if source_snapshot is set. "sourceSnapshot": "A String", # Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. }, "mountPath": "A String", # Location of this directory in the running workstation. }, ], "reconciling": True or False, # Output only. Indicates whether this resource is currently being updated to match its intended state. "runningTimeout": "A String", # How long to wait before automatically stopping a workstation after it started. A value of 0 indicates that workstations using this configuration should never time out. Must be greater than 0 and less than 24 hours if encryption_key is set. Defaults to 12 hours. "uid": "A String", # Output only. A system-assigned unique identified for this resource. "updateTime": "A String", # Output only. Time when this resource was most recently updated. }, ], }
listUsable(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission. Args: parent: string, Required. Parent resource name. (required) pageSize: integer, Maximum number of items to return. pageToken: string, next_page_token value returned from a previous List request, if any. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Response message for ListUsableWorkstationConfigs. "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. "unreachable": [ # Unreachable resources. "A String", ], "workstationConfigs": [ # The requested configs. { # A set of configuration options describing how a workstation will be run. Workstation configurations are intended to be shared across multiple workstations. "annotations": { # Client-specified annotations. "a_key": "A String", }, "conditions": [ # Output only. Status conditions describing the current resource state. { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], "message": "A 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. }, ], "container": { # A Docker container. # Container that will be run for each workstation using this configuration when that workstation is started. "args": [ # Arguments passed to the entrypoint. "A String", ], "command": [ # If set, overrides the default ENTRYPOINT specified by the image. "A String", ], "env": { # Environment variables passed to the container. "a_key": "A String", }, "image": "A String", # Docker image defining the container. This image must be accessible by the config's service account. "runAsUser": 42, # If set, overrides the USER specified in the image with the given uid. "workingDir": "A String", # If set, overrides the default DIR specified by the image. }, "createTime": "A String", # Output only. Time when this resource was created. "degraded": True or False, # Output only. Whether this resource is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in the `conditions` field. "deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Encrypts resources of this workstation configuration using a customer-managed encryption key. If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost. If the encryption key is revoked, the workstation session will automatically be stopped within 7 hours. "kmsKey": "A String", # The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. "kmsKeyServiceAccount": "A String", # The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). }, "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. "host": { # Runtime host for a workstation. # Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "bootDiskSizeGb": 42, # Size of the boot disk in GB. "confidentialInstanceConfig": { # A set of Compute Engine Confidential VM instance options. # A set of Compute Engine Confidential VM instance options. "enableConfidentialCompute": True or False, # Whether the instance has confidential compute enabled. }, "disablePublicIpAddresses": True or False, # Whether instances have no public IP address. "machineType": "A String", # The name of a Compute Engine machine type. "poolSize": 42, # Number of instances to pool for faster workstation starup. "serviceAccount": "A String", # Email address of the service account that will be used on VM instances used to support this config. This service account must have permission to pull the specified container image. If not set, VMs will run without a service account, in which case the image must be publicly accessible. "shieldedInstanceConfig": { # A set of Compute Engine Shielded instance options. # A set of Compute Engine Shielded instance options. "enableIntegrityMonitoring": True or False, # Whether the instance has integrity monitoring enabled. "enableSecureBoot": True or False, # Whether the instance has Secure Boot enabled. "enableVtpm": True or False, # Whether the instance has the vTPM enabled. }, "tags": [ # Network tags to add to the Compute Engine machines backing the Workstations. "A String", ], }, }, "idleTimeout": "A String", # How long to wait before automatically stopping an instance that hasn't received any user traffic. A value of 0 indicates that this instance should never time out due to idleness. Defaults to 20 minutes. "labels": { # Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, "name": "A String", # Full name of this resource. "persistentDirectories": [ # Directories to persist across workstation sessions. { # A directory to persist across workstation sessions. "gcePd": { # A PersistentDirectory backed by a Compute Engine regional persistent disk. # A PersistentDirectory backed by a Compute Engine persistent disk. "diskType": "A String", # Type of the disk to use. "fsType": "A String", # Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. "reclaimPolicy": "A String", # What should happen to the disk after the workstation is deleted. Defaults to DELETE. "sizeGb": 42, # Size of the disk in GB. Must be empty if source_snapshot is set. "sourceSnapshot": "A String", # Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. }, "mountPath": "A String", # Location of this directory in the running workstation. }, ], "reconciling": True or False, # Output only. Indicates whether this resource is currently being updated to match its intended state. "runningTimeout": "A String", # How long to wait before automatically stopping a workstation after it started. A value of 0 indicates that workstations using this configuration should never time out. Must be greater than 0 and less than 24 hours if encryption_key is set. Defaults to 12 hours. "uid": "A String", # Output only. A system-assigned unique identified for this resource. "updateTime": "A String", # Output only. Time when this resource was most recently updated. }, ], }
listUsable_next()
Retrieves the next page of results. Args: previous_request: The request for the previous page. (required) previous_response: The response from the request for the previous page. (required) Returns: A request object that you can call 'execute()' on to request the next page. Returns None if there are no more items in the collection.
list_next()
Retrieves the next page of results. Args: previous_request: The request for the previous page. (required) previous_response: The response from the request for the previous page. (required) Returns: A request object that you can call 'execute()' on to request the next page. Returns None if there are no more items in the collection.
patch(name, allowMissing=None, body=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates an existing workstation configuration. Args: name: string, Full name of this resource. (required) body: object, The request body. The object takes the form of: { # A set of configuration options describing how a workstation will be run. Workstation configurations are intended to be shared across multiple workstations. "annotations": { # Client-specified annotations. "a_key": "A String", }, "conditions": [ # Output only. Status conditions describing the current resource state. { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], "message": "A 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. }, ], "container": { # A Docker container. # Container that will be run for each workstation using this configuration when that workstation is started. "args": [ # Arguments passed to the entrypoint. "A String", ], "command": [ # If set, overrides the default ENTRYPOINT specified by the image. "A String", ], "env": { # Environment variables passed to the container. "a_key": "A String", }, "image": "A String", # Docker image defining the container. This image must be accessible by the config's service account. "runAsUser": 42, # If set, overrides the USER specified in the image with the given uid. "workingDir": "A String", # If set, overrides the default DIR specified by the image. }, "createTime": "A String", # Output only. Time when this resource was created. "degraded": True or False, # Output only. Whether this resource is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in the `conditions` field. "deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Encrypts resources of this workstation configuration using a customer-managed encryption key. If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost. If the encryption key is revoked, the workstation session will automatically be stopped within 7 hours. "kmsKey": "A String", # The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. "kmsKeyServiceAccount": "A String", # The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). }, "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. "host": { # Runtime host for a workstation. # Runtime host for the workstation. "gceInstance": { # A runtime using a Compute Engine instance. # Specifies a Compute Engine instance as the host. "bootDiskSizeGb": 42, # Size of the boot disk in GB. "confidentialInstanceConfig": { # A set of Compute Engine Confidential VM instance options. # A set of Compute Engine Confidential VM instance options. "enableConfidentialCompute": True or False, # Whether the instance has confidential compute enabled. }, "disablePublicIpAddresses": True or False, # Whether instances have no public IP address. "machineType": "A String", # The name of a Compute Engine machine type. "poolSize": 42, # Number of instances to pool for faster workstation starup. "serviceAccount": "A String", # Email address of the service account that will be used on VM instances used to support this config. This service account must have permission to pull the specified container image. If not set, VMs will run without a service account, in which case the image must be publicly accessible. "shieldedInstanceConfig": { # A set of Compute Engine Shielded instance options. # A set of Compute Engine Shielded instance options. "enableIntegrityMonitoring": True or False, # Whether the instance has integrity monitoring enabled. "enableSecureBoot": True or False, # Whether the instance has Secure Boot enabled. "enableVtpm": True or False, # Whether the instance has the vTPM enabled. }, "tags": [ # Network tags to add to the Compute Engine machines backing the Workstations. "A String", ], }, }, "idleTimeout": "A String", # How long to wait before automatically stopping an instance that hasn't received any user traffic. A value of 0 indicates that this instance should never time out due to idleness. Defaults to 20 minutes. "labels": { # Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, "name": "A String", # Full name of this resource. "persistentDirectories": [ # Directories to persist across workstation sessions. { # A directory to persist across workstation sessions. "gcePd": { # A PersistentDirectory backed by a Compute Engine regional persistent disk. # A PersistentDirectory backed by a Compute Engine persistent disk. "diskType": "A String", # Type of the disk to use. "fsType": "A String", # Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. "reclaimPolicy": "A String", # What should happen to the disk after the workstation is deleted. Defaults to DELETE. "sizeGb": 42, # Size of the disk in GB. Must be empty if source_snapshot is set. "sourceSnapshot": "A String", # Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. }, "mountPath": "A String", # Location of this directory in the running workstation. }, ], "reconciling": True or False, # Output only. Indicates whether this resource is currently being updated to match its intended state. "runningTimeout": "A String", # How long to wait before automatically stopping a workstation after it started. A value of 0 indicates that workstations using this configuration should never time out. Must be greater than 0 and less than 24 hours if encryption_key is set. Defaults to 12 hours. "uid": "A String", # Output only. A system-assigned unique identified for this resource. "updateTime": "A String", # Output only. Time when this resource was most recently updated. } allowMissing: boolean, If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored. updateMask: string, Required. Mask specifying which fields in the config should be updated. validateOnly: boolean, If set, validate the request and preview the review, but do not actually apply it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # This resource represents a long-running operation that is the result of a network API call. "done": True or False, # 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": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], "message": "A 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. }, "metadata": { # 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. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "name": "A 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": { # 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`. "a_key": "", # Properties of the object. Contains field @type with type URL. }, }
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. Args: resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) body: object, The request body. The object takes the form of: { # Request message for `SetIamPolicy` method. "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](https://cloud.google.com/iam/help/conditions/resource-policies). **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](https://cloud.google.com/iam/docs/). # 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 Google Cloud services (such as Projects) might reject them. "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. { # 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. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # 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. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. "A String", ], "logType": "A String", # The log type that this config enables. }, ], "service": "A 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. }, ], "bindings": [ # 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`. { # Associates `members`, or principals, with a `role`. "condition": { # 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. # 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](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A 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": "A String", # Textual representation of an expression in Common Expression Language syntax. "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. "title": "A 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. }, "members": [ # Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. }, ], "etag": "A String", # `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": 42, # 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](https://cloud.google.com/iam/help/conditions/resource-policies). }, "updateMask": "A String", # 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"` } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # 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](https://cloud.google.com/iam/help/conditions/resource-policies). **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](https://cloud.google.com/iam/docs/). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. { # 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. "auditLogConfigs": [ # The configuration for logging of each type of permission. { # 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. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. "A String", ], "logType": "A String", # The log type that this config enables. }, ], "service": "A 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. }, ], "bindings": [ # 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`. { # Associates `members`, or principals, with a `role`. "condition": { # 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. # 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](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A 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": "A String", # Textual representation of an expression in Common Expression Language syntax. "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. "title": "A 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. }, "members": [ # Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. "A String", ], "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. }, ], "etag": "A String", # `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": 42, # 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](https://cloud.google.com/iam/help/conditions/resource-policies). }
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. Args: resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) body: object, The request body. The object takes the form of: { # Request message for `TestIamPermissions` method. "permissions": [ # 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](https://cloud.google.com/iam/docs/overview#permissions). "A String", ], } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Response message for `TestIamPermissions` method. "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. "A String", ], }