Cloud Workstations API: projects. Allows administrators to create managed developer environments in the cloud. See: https://cloud.google.com/workstationsapi/reference/rest/v1/projects
Cloud Workstations API: projects. Allows administrators to create managed developer environments in the cloud. See: https://cloud.google.com/workstationsapi/reference/rest/v1/projects
(locations-get$ auth parameters)
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/get
Required parameters: name
Optional parameters: none
Gets information about a location.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/get Required parameters: name Optional parameters: none Gets information about a location.
(locations-list$ auth parameters)
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/list
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists information about the supported locations for this service.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists information about the supported locations for this service.
(locations-operations-cancel$ auth parameters body)
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/operations/cancel
Required parameters: name
Optional parameters: none
Body:
{}
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/operations/cancel Required parameters: name Optional parameters: none Body: {} Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
(locations-operations-delete$ auth parameters)
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/operations/delete
Required parameters: name
Optional parameters: none
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/operations/delete Required parameters: name Optional parameters: none Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
(locations-operations-get$ auth parameters)
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/operations/get
Required parameters: name
Optional parameters: none
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/operations/get Required parameters: name Optional parameters: none Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
(locations-operations-list$ auth parameters)
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/operations/list
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-workstationClusters-create$ auth parameters body)
Required parameters: parent
Optional parameters: workstationClusterId, validateOnly
Body:
{:labels {}, :deleteTime string, :controlPlaneIp string, :displayName string, :privateClusterConfig {:enablePrivateEndpoint boolean, :clusterHostname string, :serviceAttachmentUri string, :allowedProjects [string]}, :uid string, :name string, :createTime string, :etag string, :updateTime string, :reconciling boolean, :domainConfig {:domain string}, :conditions [{:code integer, :message string, :details [{}]}], :degraded boolean, :annotations {}, :network string, :subnetwork string}
Creates a new workstation cluster.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/create Required parameters: parent Optional parameters: workstationClusterId, validateOnly Body: {:labels {}, :deleteTime string, :controlPlaneIp string, :displayName string, :privateClusterConfig {:enablePrivateEndpoint boolean, :clusterHostname string, :serviceAttachmentUri string, :allowedProjects [string]}, :uid string, :name string, :createTime string, :etag string, :updateTime string, :reconciling boolean, :domainConfig {:domain string}, :conditions [{:code integer, :message string, :details [{}]}], :degraded boolean, :annotations {}, :network string, :subnetwork string} Creates a new workstation cluster.
(locations-workstationClusters-delete$ auth parameters)
Required parameters: name
Optional parameters: validateOnly, etag, force
Deletes the specified workstation cluster.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/delete Required parameters: name Optional parameters: validateOnly, etag, force Deletes the specified workstation cluster.
(locations-workstationClusters-get$ auth parameters)
Required parameters: name
Optional parameters: none
Returns the requested workstation cluster.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/get Required parameters: name Optional parameters: none Returns the requested workstation cluster.
(locations-workstationClusters-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Returns all workstation clusters in the specified location.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/list Required parameters: parent Optional parameters: pageSize, pageToken Returns all workstation clusters in the specified location.
(locations-workstationClusters-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask, validateOnly, allowMissing
Body:
{:labels {}, :deleteTime string, :controlPlaneIp string, :displayName string, :privateClusterConfig {:enablePrivateEndpoint boolean, :clusterHostname string, :serviceAttachmentUri string, :allowedProjects [string]}, :uid string, :name string, :createTime string, :etag string, :updateTime string, :reconciling boolean, :domainConfig {:domain string}, :conditions [{:code integer, :message string, :details [{}]}], :degraded boolean, :annotations {}, :network string, :subnetwork string}
Updates an existing workstation cluster.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/patch Required parameters: name Optional parameters: updateMask, validateOnly, allowMissing Body: {:labels {}, :deleteTime string, :controlPlaneIp string, :displayName string, :privateClusterConfig {:enablePrivateEndpoint boolean, :clusterHostname string, :serviceAttachmentUri string, :allowedProjects [string]}, :uid string, :name string, :createTime string, :etag string, :updateTime string, :reconciling boolean, :domainConfig {:domain string}, :conditions [{:code integer, :message string, :details [{}]}], :degraded boolean, :annotations {}, :network string, :subnetwork string} Updates an existing workstation cluster.
(locations-workstationClusters-workstationConfigs-create$ auth parameters body)
Required parameters: parent
Optional parameters: workstationConfigId, validateOnly
Body:
{:runningTimeout string, :labels {}, :deleteTime string, :persistentDirectories [{:gcePd GceRegionalPersistentDisk, :mountPath string}], :ephemeralDirectories [{:gcePd GcePersistentDisk, :mountPath string}], :displayName string, :enableAuditAgent boolean, :uid string, :name string, :disableTcpConnections boolean, :encryptionKey {:kmsKey string, :kmsKeyServiceAccount string}, :readinessChecks [{:path string, :port integer}], :createTime string, :etag string, :updateTime string, :reconciling boolean, :host {:gceInstance GceInstance}, :idleTimeout string, :conditions [{:code integer, :message string, :details [{}]}], :degraded boolean, :container {:image string, :command [string], :args [string], :env {}, :workingDir string, :runAsUser integer}, :annotations {}, :replicaZones [string]}
Creates a new workstation configuration.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/create Required parameters: parent Optional parameters: workstationConfigId, validateOnly Body: {:runningTimeout string, :labels {}, :deleteTime string, :persistentDirectories [{:gcePd GceRegionalPersistentDisk, :mountPath string}], :ephemeralDirectories [{:gcePd GcePersistentDisk, :mountPath string}], :displayName string, :enableAuditAgent boolean, :uid string, :name string, :disableTcpConnections boolean, :encryptionKey {:kmsKey string, :kmsKeyServiceAccount string}, :readinessChecks [{:path string, :port integer}], :createTime string, :etag string, :updateTime string, :reconciling boolean, :host {:gceInstance GceInstance}, :idleTimeout string, :conditions [{:code integer, :message string, :details [{}]}], :degraded boolean, :container {:image string, :command [string], :args [string], :env {}, :workingDir string, :runAsUser integer}, :annotations {}, :replicaZones [string]} Creates a new workstation configuration.
(locations-workstationClusters-workstationConfigs-delete$ auth parameters)
Required parameters: name
Optional parameters: validateOnly, etag, force
Deletes the specified workstation configuration.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/delete Required parameters: name Optional parameters: validateOnly, etag, force Deletes the specified workstation configuration.
(locations-workstationClusters-workstationConfigs-get$ auth parameters)
Required parameters: name
Optional parameters: none
Returns the requested workstation configuration.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/get Required parameters: name Optional parameters: none Returns the requested workstation configuration.
(locations-workstationClusters-workstationConfigs-getIamPolicy$ auth parameters)
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(locations-workstationClusters-workstationConfigs-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Returns all workstation configurations in the specified cluster.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/list Required parameters: parent Optional parameters: pageSize, pageToken Returns all workstation configurations in the specified cluster.
(locations-workstationClusters-workstationConfigs-listUsable$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/listUsable Required parameters: parent Optional parameters: pageSize, pageToken Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
(locations-workstationClusters-workstationConfigs-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask, validateOnly, allowMissing
Body:
{:runningTimeout string, :labels {}, :deleteTime string, :persistentDirectories [{:gcePd GceRegionalPersistentDisk, :mountPath string}], :ephemeralDirectories [{:gcePd GcePersistentDisk, :mountPath string}], :displayName string, :enableAuditAgent boolean, :uid string, :name string, :disableTcpConnections boolean, :encryptionKey {:kmsKey string, :kmsKeyServiceAccount string}, :readinessChecks [{:path string, :port integer}], :createTime string, :etag string, :updateTime string, :reconciling boolean, :host {:gceInstance GceInstance}, :idleTimeout string, :conditions [{:code integer, :message string, :details [{}]}], :degraded boolean, :container {:image string, :command [string], :args [string], :env {}, :workingDir string, :runAsUser integer}, :annotations {}, :replicaZones [string]}
Updates an existing workstation configuration.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/patch Required parameters: name Optional parameters: updateMask, validateOnly, allowMissing Body: {:runningTimeout string, :labels {}, :deleteTime string, :persistentDirectories [{:gcePd GceRegionalPersistentDisk, :mountPath string}], :ephemeralDirectories [{:gcePd GcePersistentDisk, :mountPath string}], :displayName string, :enableAuditAgent boolean, :uid string, :name string, :disableTcpConnections boolean, :encryptionKey {:kmsKey string, :kmsKeyServiceAccount string}, :readinessChecks [{:path string, :port integer}], :createTime string, :etag string, :updateTime string, :reconciling boolean, :host {:gceInstance GceInstance}, :idleTimeout string, :conditions [{:code integer, :message string, :details [{}]}], :degraded boolean, :container {:image string, :command [string], :args [string], :env {}, :workingDir string, :runAsUser integer}, :annotations {}, :replicaZones [string]} Updates an existing workstation configuration.
(locations-workstationClusters-workstationConfigs-setIamPolicy$ auth
parameters
body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(locations-workstationClusters-workstationConfigs-testIamPermissions$ auth
parameters
body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
(locations-workstationClusters-workstationConfigs-workstations-create$
auth
parameters
body)
Required parameters: parent
Optional parameters: workstationId, validateOnly
Body:
{:labels {}, :deleteTime string, :startTime string, :displayName string, :uid string, :name string, :createTime string, :etag string, :state string, :env {}, :updateTime string, :reconciling boolean, :host string, :kmsKey string, :annotations {}}
Creates a new workstation.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/workstations/create Required parameters: parent Optional parameters: workstationId, validateOnly Body: {:labels {}, :deleteTime string, :startTime string, :displayName string, :uid string, :name string, :createTime string, :etag string, :state string, :env {}, :updateTime string, :reconciling boolean, :host string, :kmsKey string, :annotations {}} Creates a new workstation.
(locations-workstationClusters-workstationConfigs-workstations-delete$
auth
parameters)
Required parameters: name
Optional parameters: validateOnly, etag
Deletes the specified workstation.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/workstations/delete Required parameters: name Optional parameters: validateOnly, etag Deletes the specified workstation.
(locations-workstationClusters-workstationConfigs-workstations-generateAccessToken$
auth
parameters
body)
Required parameters: workstation
Optional parameters: none
Body:
{:expireTime string, :ttl string}
Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/workstations/generateAccessToken Required parameters: workstation Optional parameters: none Body: {:expireTime string, :ttl string} Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.
(locations-workstationClusters-workstationConfigs-workstations-get$ auth
parameters)
Required parameters: name
Optional parameters: none
Returns the requested workstation.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/workstations/get Required parameters: name Optional parameters: none Returns the requested workstation.
(locations-workstationClusters-workstationConfigs-workstations-getIamPolicy$
auth
parameters)
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/workstations/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(locations-workstationClusters-workstationConfigs-workstations-list$ auth
parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Returns all Workstations using the specified workstation configuration.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/workstations/list Required parameters: parent Optional parameters: pageSize, pageToken Returns all Workstations using the specified workstation configuration.
(locations-workstationClusters-workstationConfigs-workstations-listUsable$
auth
parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/workstations/listUsable Required parameters: parent Optional parameters: pageSize, pageToken Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
(locations-workstationClusters-workstationConfigs-workstations-patch$ auth
parameters
body)
Required parameters: name
Optional parameters: updateMask, validateOnly, allowMissing
Body:
{:labels {}, :deleteTime string, :startTime string, :displayName string, :uid string, :name string, :createTime string, :etag string, :state string, :env {}, :updateTime string, :reconciling boolean, :host string, :kmsKey string, :annotations {}}
Updates an existing workstation.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/workstations/patch Required parameters: name Optional parameters: updateMask, validateOnly, allowMissing Body: {:labels {}, :deleteTime string, :startTime string, :displayName string, :uid string, :name string, :createTime string, :etag string, :state string, :env {}, :updateTime string, :reconciling boolean, :host string, :kmsKey string, :annotations {}} Updates an existing workstation.
(locations-workstationClusters-workstationConfigs-workstations-setIamPolicy$
auth
parameters
body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/workstations/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(locations-workstationClusters-workstationConfigs-workstations-start$ auth
parameters
body)
Required parameters: name
Optional parameters: none
Body:
{:validateOnly boolean, :etag string}
Starts running a workstation so that users can connect to it.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/workstations/start Required parameters: name Optional parameters: none Body: {:validateOnly boolean, :etag string} Starts running a workstation so that users can connect to it.
(locations-workstationClusters-workstationConfigs-workstations-stop$ auth
parameters
body)
Required parameters: name
Optional parameters: none
Body:
{:validateOnly boolean, :etag string}
Stops running a workstation, reducing costs.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/workstations/stop Required parameters: name Optional parameters: none Body: {:validateOnly boolean, :etag string} Stops running a workstation, reducing costs.
(locations-workstationClusters-workstationConfigs-workstations-testIamPermissions$
auth
parameters
body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/workstationsapi/reference/rest/v1/projects/locations/workstationClusters/workstationConfigs/workstations/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close