Service for interacting with Cloud Workstations.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
WorkstationsClient(WorkstationsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
WorkstationsClient const &
|
WorkstationsClient(WorkstationsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
WorkstationsClient &&
|
WorkstationsClient(std::shared_ptr< WorkstationsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< WorkstationsConnection >
|
opts |
Options
|
Operators
operator=(WorkstationsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
WorkstationsClient const &
|
Returns | |
---|---|
Type | Description |
WorkstationsClient & |
operator=(WorkstationsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
WorkstationsClient &&
|
Returns | |
---|---|
Type | Description |
WorkstationsClient & |
Functions
GetWorkstationCluster(std::string const &, Options)
Returns the requested workstation cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the requested resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::workstations::v1::WorkstationCluster > |
the result of the RPC. The response message type (google.cloud.workstations.v1.WorkstationCluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetWorkstationCluster(google::cloud::workstations::v1::GetWorkstationClusterRequest const &, Options)
Returns the requested workstation cluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::GetWorkstationClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::workstations::v1::WorkstationCluster > |
the result of the RPC. The response message type (google.cloud.workstations.v1.WorkstationCluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListWorkstationClusters(std::string const &, Options)
Returns all workstation clusters in the specified location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::workstations::v1::WorkstationCluster > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListWorkstationClusters(google::cloud::workstations::v1::ListWorkstationClustersRequest, Options)
Returns all workstation clusters in the specified location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::ListWorkstationClustersRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::workstations::v1::WorkstationCluster > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateWorkstationCluster(std::string const &, google::cloud::workstations::v1::WorkstationCluster const &, std::string const &, Options)
Creates a new workstation cluster.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent resource name. |
workstation_cluster |
google::cloud::workstations::v1::WorkstationCluster const &
Required. Workstation cluster to create. |
workstation_cluster_id |
std::string const &
Required. ID to use for the workstation cluster. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::WorkstationCluster > > |
A |
CreateWorkstationCluster(google::cloud::workstations::v1::CreateWorkstationClusterRequest const &, Options)
Creates a new workstation cluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::CreateWorkstationClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::WorkstationCluster > > |
A |
UpdateWorkstationCluster(google::cloud::workstations::v1::WorkstationCluster const &, google::protobuf::FieldMask const &, Options)
Updates an existing workstation cluster.
Parameters | |
---|---|
Name | Description |
workstation_cluster |
google::cloud::workstations::v1::WorkstationCluster const &
Required. Workstation cluster to update. |
update_mask |
google::protobuf::FieldMask const &
Required. Mask that specifies which fields in the workstation cluster should be updated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::WorkstationCluster > > |
A |
UpdateWorkstationCluster(google::cloud::workstations::v1::UpdateWorkstationClusterRequest const &, Options)
Updates an existing workstation cluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::UpdateWorkstationClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::WorkstationCluster > > |
A |
DeleteWorkstationCluster(std::string const &, Options)
Deletes the specified workstation cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the workstation cluster to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::WorkstationCluster > > |
A |
DeleteWorkstationCluster(google::cloud::workstations::v1::DeleteWorkstationClusterRequest const &, Options)
Deletes the specified workstation cluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::DeleteWorkstationClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::WorkstationCluster > > |
A |
GetWorkstationConfig(std::string const &, Options)
Returns the requested workstation configuration.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the requested resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::workstations::v1::WorkstationConfig > |
the result of the RPC. The response message type (google.cloud.workstations.v1.WorkstationConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetWorkstationConfig(google::cloud::workstations::v1::GetWorkstationConfigRequest const &, Options)
Returns the requested workstation configuration.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::GetWorkstationConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::workstations::v1::WorkstationConfig > |
the result of the RPC. The response message type (google.cloud.workstations.v1.WorkstationConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListWorkstationConfigs(std::string const &, Options)
Returns all workstation configurations in the specified cluster.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::workstations::v1::WorkstationConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListWorkstationConfigs(google::cloud::workstations::v1::ListWorkstationConfigsRequest, Options)
Returns all workstation configurations in the specified cluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::ListWorkstationConfigsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::workstations::v1::WorkstationConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListUsableWorkstationConfigs(std::string const &, Options)
Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::workstations::v1::WorkstationConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListUsableWorkstationConfigs(google::cloud::workstations::v1::ListUsableWorkstationConfigsRequest, Options)
Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::ListUsableWorkstationConfigsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::workstations::v1::WorkstationConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateWorkstationConfig(std::string const &, google::cloud::workstations::v1::WorkstationConfig const &, std::string const &, Options)
Creates a new workstation configuration.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent resource name. |
workstation_config |
google::cloud::workstations::v1::WorkstationConfig const &
Required. Config to create. |
workstation_config_id |
std::string const &
Required. ID to use for the workstation configuration. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::WorkstationConfig > > |
A |
CreateWorkstationConfig(google::cloud::workstations::v1::CreateWorkstationConfigRequest const &, Options)
Creates a new workstation configuration.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::CreateWorkstationConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::WorkstationConfig > > |
A |
UpdateWorkstationConfig(google::cloud::workstations::v1::WorkstationConfig const &, google::protobuf::FieldMask const &, Options)
Updates an existing workstation configuration.
Parameters | |
---|---|
Name | Description |
workstation_config |
google::cloud::workstations::v1::WorkstationConfig const &
Required. Config to update. |
update_mask |
google::protobuf::FieldMask const &
Required. Mask specifying which fields in the workstation configuration should be updated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::WorkstationConfig > > |
A |
UpdateWorkstationConfig(google::cloud::workstations::v1::UpdateWorkstationConfigRequest const &, Options)
Updates an existing workstation configuration.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::UpdateWorkstationConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::WorkstationConfig > > |
A |
DeleteWorkstationConfig(std::string const &, Options)
Deletes the specified workstation configuration.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the workstation configuration to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::WorkstationConfig > > |
A |
DeleteWorkstationConfig(google::cloud::workstations::v1::DeleteWorkstationConfigRequest const &, Options)
Deletes the specified workstation configuration.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::DeleteWorkstationConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::WorkstationConfig > > |
A |
GetWorkstation(std::string const &, Options)
Returns the requested workstation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the requested resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::workstations::v1::Workstation > |
the result of the RPC. The response message type (google.cloud.workstations.v1.Workstation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetWorkstation(google::cloud::workstations::v1::GetWorkstationRequest const &, Options)
Returns the requested workstation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::GetWorkstationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::workstations::v1::Workstation > |
the result of the RPC. The response message type (google.cloud.workstations.v1.Workstation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListWorkstations(std::string const &, Options)
Returns all Workstations using the specified workstation configuration.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::workstations::v1::Workstation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListWorkstations(google::cloud::workstations::v1::ListWorkstationsRequest, Options)
Returns all Workstations using the specified workstation configuration.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::ListWorkstationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::workstations::v1::Workstation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListUsableWorkstations(std::string const &, Options)
Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::workstations::v1::Workstation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListUsableWorkstations(google::cloud::workstations::v1::ListUsableWorkstationsRequest, Options)
Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::ListUsableWorkstationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::workstations::v1::Workstation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateWorkstation(std::string const &, google::cloud::workstations::v1::Workstation const &, std::string const &, Options)
Creates a new workstation.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent resource name. |
workstation |
google::cloud::workstations::v1::Workstation const &
Required. Workstation to create. |
workstation_id |
std::string const &
Required. ID to use for the workstation. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::Workstation > > |
A |
CreateWorkstation(google::cloud::workstations::v1::CreateWorkstationRequest const &, Options)
Creates a new workstation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::CreateWorkstationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::Workstation > > |
A |
UpdateWorkstation(google::cloud::workstations::v1::Workstation const &, google::protobuf::FieldMask const &, Options)
Updates an existing workstation.
Parameters | |
---|---|
Name | Description |
workstation |
google::cloud::workstations::v1::Workstation const &
Required. Workstation to update. |
update_mask |
google::protobuf::FieldMask const &
Required. Mask specifying which fields in the workstation configuration should be updated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::Workstation > > |
A |
UpdateWorkstation(google::cloud::workstations::v1::UpdateWorkstationRequest const &, Options)
Updates an existing workstation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::UpdateWorkstationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::Workstation > > |
A |
DeleteWorkstation(std::string const &, Options)
Deletes the specified workstation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the workstation to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::Workstation > > |
A |
DeleteWorkstation(google::cloud::workstations::v1::DeleteWorkstationRequest const &, Options)
Deletes the specified workstation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::DeleteWorkstationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::Workstation > > |
A |
StartWorkstation(std::string const &, Options)
Starts running a workstation so that users can connect to it.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the workstation to start. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::Workstation > > |
A |
StartWorkstation(google::cloud::workstations::v1::StartWorkstationRequest const &, Options)
Starts running a workstation so that users can connect to it.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::StartWorkstationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::Workstation > > |
A |
StopWorkstation(std::string const &, Options)
Stops running a workstation, reducing costs.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the workstation to stop. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::Workstation > > |
A |
StopWorkstation(google::cloud::workstations::v1::StopWorkstationRequest const &, Options)
Stops running a workstation, reducing costs.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::StopWorkstationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::workstations::v1::Workstation > > |
A |
GenerateAccessToken(std::string const &, Options)
Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.
Parameters | |
---|---|
Name | Description |
workstation |
std::string const &
Required. Name of the workstation for which the access token should be generated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::workstations::v1::GenerateAccessTokenResponse > |
the result of the RPC. The response message type (google.cloud.workstations.v1.GenerateAccessTokenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GenerateAccessToken(google::cloud::workstations::v1::GenerateAccessTokenRequest const &, Options)
Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::workstations::v1::GenerateAccessTokenRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::workstations::v1::GenerateAccessTokenResponse > |
the result of the RPC. The response message type (google.cloud.workstations.v1.GenerateAccessTokenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |