Cloud Workstations API . projects . locations . workstationClusters

Instance Methods

workstationConfigs()

Returns the workstationConfigs Resource.

close()

Close httplib2 connections.

create(parent, body=None, validateOnly=None, workstationClusterId=None, x__xgafv=None)

Creates a new workstation cluster.

delete(name, etag=None, force=None, validateOnly=None, x__xgafv=None)

Deletes the specified workstation cluster.

get(name, x__xgafv=None)

Returns the requested workstation cluster.

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

Returns all workstation clusters in the specified location.

list_next()

Retrieves the next page of results.

patch(name, allowMissing=None, body=None, updateMask=None, validateOnly=None, x__xgafv=None)

Updates an existing workstation cluster.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, validateOnly=None, workstationClusterId=None, x__xgafv=None)
Creates a new workstation cluster.

Args:
  parent: string, Required. Parent resource name. (required)
  body: object, The request body.
    The object takes the form of:

{ # A grouping of workstation configurations and the associated workstations in that region.
  "annotations": { # Client-specified annotations.
    "a_key": "A String",
  },
  "conditions": [ # Output only. Status conditions describing the current resource state.
    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    },
  ],
  "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.
  "name": "A String", # Full name of this resource.
  "network": "A String", # Name of the Compute Engine network in which instances associated with this cluster will be created.
  "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.
    "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
    "enablePrivateEndpoint": True or False, # Whether Workstations endpoint is private.
    "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the cluster, configure access to the managed service using (Private Service Connect)[https://cloud.google.com/vpc/docs/configure-private-service-connect-services].
  },
  "reconciling": True or False, # Output only. Indicates whether this resource is currently being updated to match its intended state.
  "subnetwork": "A String", # Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. Must be part of the subnetwork specified for this cluster.
  "uid": "A String", # Output only. A system-assigned unique identified for this resource.
  "updateTime": "A String", # Output only. Time when this resource was most recently updated.
}

  validateOnly: boolean, If set, validate the request and preview the review, but do not actually apply it.
  workstationClusterId: string, Required. ID to use for the cluster.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
delete(name, etag=None, force=None, validateOnly=None, x__xgafv=None)
Deletes the specified workstation cluster.

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

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
get(name, x__xgafv=None)
Returns the requested workstation cluster.

Args:
  name: string, Required. Name of the requested resource. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A grouping of workstation configurations and the associated workstations in that region.
  "annotations": { # Client-specified annotations.
    "a_key": "A String",
  },
  "conditions": [ # Output only. Status conditions describing the current resource state.
    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    },
  ],
  "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.
  "name": "A String", # Full name of this resource.
  "network": "A String", # Name of the Compute Engine network in which instances associated with this cluster will be created.
  "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.
    "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
    "enablePrivateEndpoint": True or False, # Whether Workstations endpoint is private.
    "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the cluster, configure access to the managed service using (Private Service Connect)[https://cloud.google.com/vpc/docs/configure-private-service-connect-services].
  },
  "reconciling": True or False, # Output only. Indicates whether this resource is currently being updated to match its intended state.
  "subnetwork": "A String", # Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. Must be part of the subnetwork specified for this cluster.
  "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.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns all workstation clusters in the specified location.

Args:
  parent: string, Required. Parent resource name. (required)
  pageSize: integer, Maximum number of items to return.
  pageToken: string, next_page_token value returned from a previous List request, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListWorkstationClusters.
  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
  "unreachable": [ # Unreachable resources.
    "A String",
  ],
  "workstationClusters": [ # The requested clusters.
    { # A grouping of workstation configurations and the associated workstations in that region.
      "annotations": { # Client-specified annotations.
        "a_key": "A String",
      },
      "conditions": [ # Output only. Status conditions describing the current resource state.
        { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
        },
      ],
      "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.
      "name": "A String", # Full name of this resource.
      "network": "A String", # Name of the Compute Engine network in which instances associated with this cluster will be created.
      "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.
        "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
        "enablePrivateEndpoint": True or False, # Whether Workstations endpoint is private.
        "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the cluster, configure access to the managed service using (Private Service Connect)[https://cloud.google.com/vpc/docs/configure-private-service-connect-services].
      },
      "reconciling": True or False, # Output only. Indicates whether this resource is currently being updated to match its intended state.
      "subnetwork": "A String", # Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. Must be part of the subnetwork specified for this cluster.
      "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.
    },
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
patch(name, allowMissing=None, body=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates an existing workstation cluster.

Args:
  name: string, Full name of this resource. (required)
  body: object, The request body.
    The object takes the form of:

{ # A grouping of workstation configurations and the associated workstations in that region.
  "annotations": { # Client-specified annotations.
    "a_key": "A String",
  },
  "conditions": [ # Output only. Status conditions describing the current resource state.
    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    },
  ],
  "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.
  "name": "A String", # Full name of this resource.
  "network": "A String", # Name of the Compute Engine network in which instances associated with this cluster will be created.
  "privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.
    "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
    "enablePrivateEndpoint": True or False, # Whether Workstations endpoint is private.
    "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the cluster, configure access to the managed service using (Private Service Connect)[https://cloud.google.com/vpc/docs/configure-private-service-connect-services].
  },
  "reconciling": True or False, # Output only. Indicates whether this resource is currently being updated to match its intended state.
  "subnetwork": "A String", # Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. Must be part of the subnetwork specified for this cluster.
  "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 cluster is not found, a new cluster will be created. In this situation, update_mask is ignored.
  updateMask: string, Required. Mask specifying which fields in the cluster should be updated.
  validateOnly: boolean, If set, validate the request and preview the review, but do not actually apply it.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}