From 89063f62ff8839f101e4e2f41bc702ce1f8de88d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Wed, 24 May 2023 18:27:17 +0000 Subject: [PATCH] feat(workstations): update the api #### workstations:v1beta The following keys were added: - schemas.Accelerator (Total Keys: 5) - schemas.GceInstance.properties.accelerators (Total Keys: 2) - schemas.GceInstance.properties.pooledInstances (Total Keys: 3) - schemas.ReadinessCheck (Total Keys: 5) - schemas.WorkstationConfig.properties.readinessChecks (Total Keys: 2) --- ...rojects.locations.workstationClusters.html | 18 +-- ...orkstationClusters.workstationConfigs.html | 147 +++++++++++++----- ...sters.workstationConfigs.workstations.html | 40 ++--- .../documents/workstations.v1beta.json | 108 +++++++++---- 4 files changed, 215 insertions(+), 98 deletions(-) diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html index 9f5a5125f75..d6f2c7dfb83 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html @@ -130,12 +130,12 @@

Method Details

"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. }, ], - "controlPlaneIp": "A String", # Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so please ensure your firewall rules allow egress from the Workstation VMs to this address. + "controlPlaneIp": "A String", # Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. "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. - "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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "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", }, @@ -192,7 +192,7 @@

Method Details

Args: name: string, Required. Name of the workstation cluster to delete. (required) - etag: string, If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this etag. + etag: string, If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag. force: boolean, If set, any workstation configurations and workstations in the workstation cluster are also deleted. Otherwise, the request only works if the workstation cluster has no configurations or workstations. validateOnly: boolean, If set, validate the request and preview the review, but do not apply it. x__xgafv: string, V1 error format. @@ -253,12 +253,12 @@

Method Details

"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. }, ], - "controlPlaneIp": "A String", # Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so please ensure your firewall rules allow egress from the Workstation VMs to this address. + "controlPlaneIp": "A String", # Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. "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. - "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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "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", }, @@ -316,12 +316,12 @@

Method Details

"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. }, ], - "controlPlaneIp": "A String", # Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so please ensure your firewall rules allow egress from the Workstation VMs to this address. + "controlPlaneIp": "A String", # Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. "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. - "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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "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", }, @@ -382,12 +382,12 @@

Method Details

"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. }, ], - "controlPlaneIp": "A String", # Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so please ensure your firewall rules allow egress from the Workstation VMs to this address. + "controlPlaneIp": "A String", # Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. "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. - "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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "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", }, diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html index 459d49f3067..96c2f0e6252 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html @@ -152,10 +152,10 @@

Method Details

"command": [ # If set, overrides the default ENTRYPOINT specified by the image. "A String", ], - "env": { # Environment variables passed to the container. + "env": { # Environment variables passed to the container's entrypoint. "a_key": "A String", }, - "image": "A String", # Docker image defining the container. This image must be accessible by the config's service account. + "image": "A String", # Docker image defining the container. This image must be accessible by the service account specified in the workstation configuration. "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. }, @@ -164,21 +164,28 @@

Method Details

"deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. "enableAuditAgent": True or False, # Whether to enable linux auditd logging on the workstation. When enabled, a service account must also be specified that has logging.buckets.write permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). - "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Immutable. 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. Immutable after workstation config is created. - "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. + "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Immutable. 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. Immutable after the workstation configuration is created. + "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. 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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure 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. + "accelerators": [ # A list of the type and count of accelerator cards attached to the instance. + { # An accelerator card attached to the instance. + "count": 42, # Number of accelerator cards exposed to the instance. + "type": "A String", # Type of accelerator resource to attach to the instance, for example, "nvidia-tesla-p100". + }, + ], "bootDiskSizeGb": 42, # Size of the boot disk in GB. Defaults to 50. "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. If not set, VMs will run with a Google-managed service account. This service account must have permission to pull the specified container image, otherwise the image must be publicly accessible. + "poolSize": 42, # Number of instances to pool for faster workstation startup. + "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. + "serviceAccount": "A String", # Email address of the service account used on VM instances used to support this configuration. If not set, VMs run with a Google-managed service account. This service account must have permission to pull the specified container image; otherwise, 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. @@ -206,6 +213,12 @@

Method Details

"mountPath": "A String", # Location of this directory in the running workstation. }, ], + "readinessChecks": [ # Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes. + { # A readiness check to be performed on a workstation. + "path": "A String", # Path to which the request should be sent. + "port": 42, # Port to which the request should be sent. + }, + ], "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. @@ -213,7 +226,7 @@

Method Details

} 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. + workstationConfigId: string, Required. ID to use for the workstation configuration. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -248,9 +261,9 @@

Method Details

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.
+  name: string, Required. Name of the workstation configuration to delete. (required)
+  etag: string, If set, the request is rejected if the latest version of the workstation configuration on the server does not have this ETag.
+  force: boolean, If set, any workstations in the workstation configuration are also deleted. Otherwise, the request works only if the workstation configuration 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
@@ -317,10 +330,10 @@ 

Method Details

"command": [ # If set, overrides the default ENTRYPOINT specified by the image. "A String", ], - "env": { # Environment variables passed to the container. + "env": { # Environment variables passed to the container's entrypoint. "a_key": "A String", }, - "image": "A String", # Docker image defining the container. This image must be accessible by the config's service account. + "image": "A String", # Docker image defining the container. This image must be accessible by the service account specified in the workstation configuration. "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. }, @@ -329,21 +342,28 @@

Method Details

"deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. "enableAuditAgent": True or False, # Whether to enable linux auditd logging on the workstation. When enabled, a service account must also be specified that has logging.buckets.write permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). - "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Immutable. 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. Immutable after workstation config is created. - "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. + "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Immutable. 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. Immutable after the workstation configuration is created. + "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. 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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure 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. + "accelerators": [ # A list of the type and count of accelerator cards attached to the instance. + { # An accelerator card attached to the instance. + "count": 42, # Number of accelerator cards exposed to the instance. + "type": "A String", # Type of accelerator resource to attach to the instance, for example, "nvidia-tesla-p100". + }, + ], "bootDiskSizeGb": 42, # Size of the boot disk in GB. Defaults to 50. "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. If not set, VMs will run with a Google-managed service account. This service account must have permission to pull the specified container image, otherwise the image must be publicly accessible. + "poolSize": 42, # Number of instances to pool for faster workstation startup. + "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. + "serviceAccount": "A String", # Email address of the service account used on VM instances used to support this configuration. If not set, VMs run with a Google-managed service account. This service account must have permission to pull the specified container image; otherwise, 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. @@ -371,6 +391,12 @@

Method Details

"mountPath": "A String", # Location of this directory in the running workstation. }, ], + "readinessChecks": [ # Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes. + { # A readiness check to be performed on a workstation. + "path": "A String", # Path to which the request should be sent. + "port": 42, # Port to which the request should be sent. + }, + ], "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. @@ -470,10 +496,10 @@

Method Details

"command": [ # If set, overrides the default ENTRYPOINT specified by the image. "A String", ], - "env": { # Environment variables passed to the container. + "env": { # Environment variables passed to the container's entrypoint. "a_key": "A String", }, - "image": "A String", # Docker image defining the container. This image must be accessible by the config's service account. + "image": "A String", # Docker image defining the container. This image must be accessible by the service account specified in the workstation configuration. "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. }, @@ -482,21 +508,28 @@

Method Details

"deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. "enableAuditAgent": True or False, # Whether to enable linux auditd logging on the workstation. When enabled, a service account must also be specified that has logging.buckets.write permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). - "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Immutable. 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. Immutable after workstation config is created. - "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. + "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Immutable. 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. Immutable after the workstation configuration is created. + "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. 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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure 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. + "accelerators": [ # A list of the type and count of accelerator cards attached to the instance. + { # An accelerator card attached to the instance. + "count": 42, # Number of accelerator cards exposed to the instance. + "type": "A String", # Type of accelerator resource to attach to the instance, for example, "nvidia-tesla-p100". + }, + ], "bootDiskSizeGb": 42, # Size of the boot disk in GB. Defaults to 50. "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. If not set, VMs will run with a Google-managed service account. This service account must have permission to pull the specified container image, otherwise the image must be publicly accessible. + "poolSize": 42, # Number of instances to pool for faster workstation startup. + "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. + "serviceAccount": "A String", # Email address of the service account used on VM instances used to support this configuration. If not set, VMs run with a Google-managed service account. This service account must have permission to pull the specified container image; otherwise, 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. @@ -524,6 +557,12 @@

Method Details

"mountPath": "A String", # Location of this directory in the running workstation. }, ], + "readinessChecks": [ # Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes. + { # A readiness check to be performed on a workstation. + "path": "A String", # Path to which the request should be sent. + "port": 42, # Port to which the request should be sent. + }, + ], "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. @@ -577,10 +616,10 @@

Method Details

"command": [ # If set, overrides the default ENTRYPOINT specified by the image. "A String", ], - "env": { # Environment variables passed to the container. + "env": { # Environment variables passed to the container's entrypoint. "a_key": "A String", }, - "image": "A String", # Docker image defining the container. This image must be accessible by the config's service account. + "image": "A String", # Docker image defining the container. This image must be accessible by the service account specified in the workstation configuration. "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. }, @@ -589,21 +628,28 @@

Method Details

"deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. "enableAuditAgent": True or False, # Whether to enable linux auditd logging on the workstation. When enabled, a service account must also be specified that has logging.buckets.write permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). - "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Immutable. 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. Immutable after workstation config is created. - "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. + "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Immutable. 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. Immutable after the workstation configuration is created. + "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. 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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure 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. + "accelerators": [ # A list of the type and count of accelerator cards attached to the instance. + { # An accelerator card attached to the instance. + "count": 42, # Number of accelerator cards exposed to the instance. + "type": "A String", # Type of accelerator resource to attach to the instance, for example, "nvidia-tesla-p100". + }, + ], "bootDiskSizeGb": 42, # Size of the boot disk in GB. Defaults to 50. "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. If not set, VMs will run with a Google-managed service account. This service account must have permission to pull the specified container image, otherwise the image must be publicly accessible. + "poolSize": 42, # Number of instances to pool for faster workstation startup. + "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. + "serviceAccount": "A String", # Email address of the service account used on VM instances used to support this configuration. If not set, VMs run with a Google-managed service account. This service account must have permission to pull the specified container image; otherwise, 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. @@ -631,6 +677,12 @@

Method Details

"mountPath": "A String", # Location of this directory in the running workstation. }, ], + "readinessChecks": [ # Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes. + { # A readiness check to be performed on a workstation. + "path": "A String", # Path to which the request should be sent. + "port": 42, # Port to which the request should be sent. + }, + ], "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. @@ -699,10 +751,10 @@

Method Details

"command": [ # If set, overrides the default ENTRYPOINT specified by the image. "A String", ], - "env": { # Environment variables passed to the container. + "env": { # Environment variables passed to the container's entrypoint. "a_key": "A String", }, - "image": "A String", # Docker image defining the container. This image must be accessible by the config's service account. + "image": "A String", # Docker image defining the container. This image must be accessible by the service account specified in the workstation configuration. "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. }, @@ -711,21 +763,28 @@

Method Details

"deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. "enableAuditAgent": True or False, # Whether to enable linux auditd logging on the workstation. When enabled, a service account must also be specified that has logging.buckets.write permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). - "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Immutable. 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. Immutable after workstation config is created. - "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. + "encryptionKey": { # A customer-managed encryption key for the Compute Engine resources of this workstation configuration. # Immutable. 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. Immutable after the workstation configuration is created. + "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. 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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure 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. + "accelerators": [ # A list of the type and count of accelerator cards attached to the instance. + { # An accelerator card attached to the instance. + "count": 42, # Number of accelerator cards exposed to the instance. + "type": "A String", # Type of accelerator resource to attach to the instance, for example, "nvidia-tesla-p100". + }, + ], "bootDiskSizeGb": 42, # Size of the boot disk in GB. Defaults to 50. "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. If not set, VMs will run with a Google-managed service account. This service account must have permission to pull the specified container image, otherwise the image must be publicly accessible. + "poolSize": 42, # Number of instances to pool for faster workstation startup. + "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. + "serviceAccount": "A String", # Email address of the service account used on VM instances used to support this configuration. If not set, VMs run with a Google-managed service account. This service account must have permission to pull the specified container image; otherwise, 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. @@ -753,14 +812,20 @@

Method Details

"mountPath": "A String", # Location of this directory in the running workstation. }, ], + "readinessChecks": [ # Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes. + { # A readiness check to be performed on a workstation. + "path": "A String", # Path to which the request should be sent. + "port": 42, # Port to which the request should be sent. + }, + ], "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. + allowMissing: boolean, If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored. + updateMask: string, Required. Mask specifying which fields in the workstation configuration 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 diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html index 42156f3609a..6aac8aa3564 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html @@ -94,10 +94,10 @@

Instance Methods

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 Workstations using the specified config.

+

Returns all Workstations using the specified workstation configuration.

listUsable(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

Returns all Workstations using the specified config on which the caller has the "workstations.workstations.use" permission.

+

Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.

listUsable_next()

Retrieves the next page of results.

@@ -141,10 +141,10 @@

Method Details

"createTime": "A String", # Output only. Time when this resource was created. "deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. - "env": { # Environment variables passed to the workstation container. + "env": { # Environment variables passed to the workstation container's entrypoint. "a_key": "A String", }, - "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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "host": "A String", # Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`. "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", @@ -193,7 +193,7 @@

Method Details

Args: name: string, Required. Name of the workstation to delete. (required) - etag: string, If set, the request will be rejected if the latest version of the workstation on the server does not have this etag. + etag: string, If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. 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 @@ -247,7 +247,7 @@

Method Details

An object of the form: { # Response message for GenerateAccessToken. - "accessToken": "A String", # The generated bearer access token. To use this token, include it in an Authorization header of an HTTP request sent to the associated workstation's hostname, for example, `Authorization: Bearer `. + "accessToken": "A String", # The generated bearer access token. To use this token, include it in an Authorization header of an HTTP request sent to the associated workstation's hostname—for example, `Authorization: Bearer `. "expireTime": "A String", # Time at which the generated token will expire. }
@@ -273,10 +273,10 @@

Method Details

"createTime": "A String", # Output only. Time when this resource was created. "deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. - "env": { # Environment variables passed to the workstation container. + "env": { # Environment variables passed to the workstation container's entrypoint. "a_key": "A String", }, - "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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "host": "A String", # Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`. "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", @@ -339,7 +339,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns all Workstations using the specified config.
+  
Returns all Workstations using the specified workstation configuration.
 
 Args:
   parent: string, Required. Parent resource name. (required)
@@ -366,10 +366,10 @@ 

Method Details

"createTime": "A String", # Output only. Time when this resource was created. "deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. - "env": { # Environment variables passed to the workstation container. + "env": { # Environment variables passed to the workstation container's entrypoint. "a_key": "A String", }, - "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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "host": "A String", # Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`. "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", @@ -386,7 +386,7 @@

Method Details

listUsable(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns all Workstations using the specified config on which the caller has the "workstations.workstations.use" permission.
+  
Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
 
 Args:
   parent: string, Required. Parent resource name. (required)
@@ -413,10 +413,10 @@ 

Method Details

"createTime": "A String", # Output only. Time when this resource was created. "deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. - "env": { # Environment variables passed to the workstation container. + "env": { # Environment variables passed to the workstation container's entrypoint. "a_key": "A String", }, - "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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "host": "A String", # Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`. "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", @@ -475,10 +475,10 @@

Method Details

"createTime": "A String", # Output only. Time when this resource was created. "deleteTime": "A String", # Output only. Time when this resource was soft-deleted. "displayName": "A String", # Human-readable name for this resource. - "env": { # Environment variables passed to the workstation container. + "env": { # Environment variables passed to the workstation container's entrypoint. "a_key": "A String", }, - "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. + "etag": "A String", # Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "host": "A String", # Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`. "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", @@ -490,8 +490,8 @@

Method Details

"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. + allowMissing: boolean, If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored. + updateMask: string, Required. Mask specifying which fields in the workstation configuration 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 @@ -617,7 +617,7 @@

Method Details

The object takes the form of: { # Request message for StartWorkstation. - "etag": "A String", # If set, the request will be rejected if the latest version of the workstation on the server does not have this etag. + "etag": "A String", # If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. "validateOnly": True or False, # If set, validate the request and preview the review, but do not actually apply it. } @@ -660,7 +660,7 @@

Method Details

The object takes the form of: { # Request message for StopWorkstation. - "etag": "A String", # If set, the request will be rejected if the latest version of the workstation on the server does not have this etag. + "etag": "A String", # If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. "validateOnly": True or False, # If set, validate the request and preview the review, but do not actually apply it. } diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index 51fbf5631a1..bc279151b32 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -12,7 +12,7 @@ "baseUrl": "https://workstations.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Workstations", - "description": "", + "description": "Allows administrators to create managed developer environments in the cloud. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/workstations", "fullyEncodeReservedExpansion": true, @@ -282,7 +282,7 @@ ], "parameters": { "etag": { - "description": "If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this etag.", + "description": "If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag.", "location": "query", "type": "string" }, @@ -443,7 +443,7 @@ "type": "boolean" }, "workstationConfigId": { - "description": "Required. ID to use for the config.", + "description": "Required. ID to use for the workstation configuration.", "location": "query", "type": "string" } @@ -469,17 +469,17 @@ ], "parameters": { "etag": { - "description": "If set, the request will be rejected if the latest version of the config on the server does not have this etag.", + "description": "If set, the request is rejected if the latest version of the workstation configuration on the server does not have this ETag.", "location": "query", "type": "string" }, "force": { - "description": "If set, any Workstations in the config will also be deleted. Otherwise, the request will work only if the config has no workstations.", + "description": "If set, any workstations in the workstation configuration are also deleted. Otherwise, the request works only if the workstation configuration has no workstations.", "location": "query", "type": "boolean" }, "name": { - "description": "Required. Name of the config to delete.", + "description": "Required. Name of the workstation configuration to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$", "required": true, @@ -637,7 +637,7 @@ ], "parameters": { "allowMissing": { - "description": "If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored.", + "description": "If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored.", "location": "query", "type": "boolean" }, @@ -649,7 +649,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Mask specifying which fields in the config should be updated.", + "description": "Required. Mask specifying which fields in the workstation configuration should be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -779,7 +779,7 @@ ], "parameters": { "etag": { - "description": "If set, the request will be rejected if the latest version of the workstation on the server does not have this etag.", + "description": "If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.", "location": "query", "type": "string" }, @@ -889,7 +889,7 @@ ] }, "list": { - "description": "Returns all Workstations using the specified config.", + "description": "Returns all Workstations using the specified workstation configuration.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations", "httpMethod": "GET", "id": "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.list", @@ -925,7 +925,7 @@ ] }, "listUsable": { - "description": "Returns all Workstations using the specified config on which the caller has the \"workstations.workstations.use\" permission.", + "description": "Returns all workstations using the specified workstation configuration on which the caller has the \"workstations.workstations.use\" permission.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations:listUsable", "httpMethod": "GET", "id": "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.listUsable", @@ -970,7 +970,7 @@ ], "parameters": { "allowMissing": { - "description": "If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored.", + "description": "If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored.", "location": "query", "type": "boolean" }, @@ -982,7 +982,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Mask specifying which fields in the config should be updated.", + "description": "Required. Mask specifying which fields in the workstation configuration should be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1127,9 +1127,25 @@ } } }, - "revision": "20230405", + "revision": "20230517", "rootUrl": "https://workstations.googleapis.com/", "schemas": { + "Accelerator": { + "description": "An accelerator card attached to the instance.", + "id": "Accelerator", + "properties": { + "count": { + "description": "Number of accelerator cards exposed to the instance.", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "Type of accelerator resource to attach to the instance, for example, \"nvidia-tesla-p100\".", + "type": "string" + } + }, + "type": "object" + }, "AuditConfig": { "description": "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.", "id": "AuditConfig", @@ -1228,11 +1244,11 @@ "additionalProperties": { "type": "string" }, - "description": "Environment variables passed to the container.", + "description": "Environment variables passed to the container's entrypoint.", "type": "object" }, "image": { - "description": "Docker image defining the container. This image must be accessible by the config's service account.", + "description": "Docker image defining the container. This image must be accessible by the service account specified in the workstation configuration.", "type": "string" }, "runAsUser": { @@ -1252,7 +1268,7 @@ "id": "CustomerEncryptionKey", "properties": { "kmsKey": { - "description": "Immutable. The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`.", + "description": "Immutable. The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. The key must be in the same region as the workstation configuration.", "type": "string" }, "kmsKeyServiceAccount": { @@ -1300,6 +1316,13 @@ "description": "A runtime using a Compute Engine instance.", "id": "GceInstance", "properties": { + "accelerators": { + "description": "A list of the type and count of accelerator cards attached to the instance.", + "items": { + "$ref": "Accelerator" + }, + "type": "array" + }, "bootDiskSizeGb": { "description": "Size of the boot disk in GB. Defaults to 50.", "format": "int32", @@ -1318,12 +1341,18 @@ "type": "string" }, "poolSize": { - "description": "Number of instances to pool for faster workstation starup.", + "description": "Number of instances to pool for faster workstation startup.", + "format": "int32", + "type": "integer" + }, + "pooledInstances": { + "description": "Output only. Number of instances currently available in the pool for faster workstation startup.", "format": "int32", + "readOnly": true, "type": "integer" }, "serviceAccount": { - "description": "Email address of the service account that will be used on VM instances used to support this config. If not set, VMs will run with a Google-managed service account. This service account must have permission to pull the specified container image, otherwise the image must be publicly accessible.", + "description": "Email address of the service account used on VM instances used to support this configuration. If not set, VMs run with a Google-managed service account. This service account must have permission to pull the specified container image; otherwise, the image must be publicly accessible.", "type": "string" }, "shieldedInstanceConfig": { @@ -1419,7 +1448,7 @@ "id": "GenerateAccessTokenResponse", "properties": { "accessToken": { - "description": "The generated bearer access token. To use this token, include it in an Authorization header of an HTTP request sent to the associated workstation's hostname, for example, `Authorization: Bearer `.", + "description": "The generated bearer access token. To use this token, include it in an Authorization header of an HTTP request sent to the associated workstation's hostname\u2014for example, `Authorization: Bearer `.", "type": "string" }, "expireTime": { @@ -1743,6 +1772,22 @@ }, "type": "object" }, + "ReadinessCheck": { + "description": "A readiness check to be performed on a workstation.", + "id": "ReadinessCheck", + "properties": { + "path": { + "description": "Path to which the request should be sent.", + "type": "string" + }, + "port": { + "description": "Port to which the request should be sent.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -1764,7 +1809,7 @@ "id": "StartWorkstationRequest", "properties": { "etag": { - "description": "If set, the request will be rejected if the latest version of the workstation on the server does not have this etag.", + "description": "If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.", "type": "string" }, "validateOnly": { @@ -1806,7 +1851,7 @@ "id": "StopWorkstationRequest", "properties": { "etag": { - "description": "If set, the request will be rejected if the latest version of the workstation on the server does not have this etag.", + "description": "If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.", "type": "string" }, "validateOnly": { @@ -1875,11 +1920,11 @@ "additionalProperties": { "type": "string" }, - "description": "Environment variables passed to the workstation container.", + "description": "Environment variables passed to the workstation container's entrypoint.", "type": "object" }, "etag": { - "description": "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.", + "description": "Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.", "type": "string" }, "host": { @@ -1956,7 +2001,7 @@ "type": "array" }, "controlPlaneIp": { - "description": "Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so please ensure your firewall rules allow egress from the Workstation VMs to this address.", + "description": "Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.", "readOnly": true, "type": "string" }, @@ -1982,7 +2027,7 @@ "type": "string" }, "etag": { - "description": "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.", + "description": "Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.", "type": "string" }, "labels": { @@ -2077,10 +2122,10 @@ }, "encryptionKey": { "$ref": "CustomerEncryptionKey", - "description": "Immutable. 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. Immutable after workstation config is created." + "description": "Immutable. 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. Immutable after the workstation configuration is created." }, "etag": { - "description": "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.", + "description": "Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.", "type": "string" }, "host": { @@ -2110,6 +2155,13 @@ }, "type": "array" }, + "readinessChecks": { + "description": "Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.", + "items": { + "$ref": "ReadinessCheck" + }, + "type": "array" + }, "reconciling": { "description": "Output only. Indicates whether this resource is currently being updated to match its intended state.", "readOnly": true,