Class WorkstationsClient (2.45.0-rc)

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.GetWorkstationClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 StatusOr contains the error details.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.workstations.v1.WorkstationCluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.ListWorkstationClustersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.workstations.v1.WorkstationCluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.WorkstationCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateWorkstationCluster(NoAwaitTag, std::string const &, google::cloud::workstations::v1::WorkstationCluster const &, std::string const &, Options)

Creates a new workstation cluster.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
workstation_cluster google::cloud::workstations::v1::WorkstationCluster const &
workstation_cluster_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.CreateWorkstationClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.WorkstationCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateWorkstationCluster(NoAwaitTag, google::cloud::workstations::v1::CreateWorkstationClusterRequest const &, Options)

Creates a new workstation cluster.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::workstations::v1::CreateWorkstationClusterRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateWorkstationCluster(google::longrunning::Operation const &, Options)

Creates a new workstation cluster.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::workstations::v1::WorkstationCluster > >

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.WorkstationCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateWorkstationCluster(NoAwaitTag, google::cloud::workstations::v1::WorkstationCluster const &, google::protobuf::FieldMask const &, Options)

Updates an existing workstation cluster.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
workstation_cluster google::cloud::workstations::v1::WorkstationCluster const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.UpdateWorkstationClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.WorkstationCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateWorkstationCluster(NoAwaitTag, google::cloud::workstations::v1::UpdateWorkstationClusterRequest const &, Options)

Updates an existing workstation cluster.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::workstations::v1::UpdateWorkstationClusterRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateWorkstationCluster(google::longrunning::Operation const &, Options)

Updates an existing workstation cluster.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::workstations::v1::WorkstationCluster > >

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.WorkstationCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteWorkstationCluster(NoAwaitTag, std::string const &, Options)

Deletes the specified workstation cluster.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.DeleteWorkstationClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.WorkstationCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteWorkstationCluster(NoAwaitTag, google::cloud::workstations::v1::DeleteWorkstationClusterRequest const &, Options)

Deletes the specified workstation cluster.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::workstations::v1::DeleteWorkstationClusterRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteWorkstationCluster(google::longrunning::Operation const &, Options)

Deletes the specified workstation cluster.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::workstations::v1::WorkstationCluster > >

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.GetWorkstationConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 StatusOr contains the error details.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.workstations.v1.WorkstationConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.ListWorkstationConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.workstations.v1.WorkstationConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.workstations.v1.WorkstationConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.ListUsableWorkstationConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.workstations.v1.WorkstationConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.WorkstationConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateWorkstationConfig(NoAwaitTag, std::string const &, google::cloud::workstations::v1::WorkstationConfig const &, std::string const &, Options)

Creates a new workstation configuration.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
workstation_config google::cloud::workstations::v1::WorkstationConfig const &
workstation_config_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.CreateWorkstationConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.WorkstationConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateWorkstationConfig(NoAwaitTag, google::cloud::workstations::v1::CreateWorkstationConfigRequest const &, Options)

Creates a new workstation configuration.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::workstations::v1::CreateWorkstationConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateWorkstationConfig(google::longrunning::Operation const &, Options)

Creates a new workstation configuration.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::workstations::v1::WorkstationConfig > >

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.WorkstationConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateWorkstationConfig(NoAwaitTag, google::cloud::workstations::v1::WorkstationConfig const &, google::protobuf::FieldMask const &, Options)

Updates an existing workstation configuration.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
workstation_config google::cloud::workstations::v1::WorkstationConfig const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.UpdateWorkstationConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.WorkstationConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateWorkstationConfig(NoAwaitTag, google::cloud::workstations::v1::UpdateWorkstationConfigRequest const &, Options)

Updates an existing workstation configuration.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::workstations::v1::UpdateWorkstationConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateWorkstationConfig(google::longrunning::Operation const &, Options)

Updates an existing workstation configuration.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::workstations::v1::WorkstationConfig > >

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.WorkstationConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteWorkstationConfig(NoAwaitTag, std::string const &, Options)

Deletes the specified workstation configuration.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.DeleteWorkstationConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.WorkstationConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteWorkstationConfig(NoAwaitTag, google::cloud::workstations::v1::DeleteWorkstationConfigRequest const &, Options)

Deletes the specified workstation configuration.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::workstations::v1::DeleteWorkstationConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteWorkstationConfig(google::longrunning::Operation const &, Options)

Deletes the specified workstation configuration.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::workstations::v1::WorkstationConfig > >

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.GetWorkstationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 StatusOr contains the error details.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.workstations.v1.Workstation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.ListWorkstationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.workstations.v1.Workstation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.workstations.v1.Workstation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.ListUsableWorkstationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.workstations.v1.Workstation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.Workstation proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateWorkstation(NoAwaitTag, std::string const &, google::cloud::workstations::v1::Workstation const &, std::string const &, Options)

Creates a new workstation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
workstation google::cloud::workstations::v1::Workstation const &
workstation_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.CreateWorkstationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.Workstation proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateWorkstation(NoAwaitTag, google::cloud::workstations::v1::CreateWorkstationRequest const &, Options)

Creates a new workstation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::workstations::v1::CreateWorkstationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateWorkstation(google::longrunning::Operation const &, Options)

Creates a new workstation.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::workstations::v1::Workstation > >

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.Workstation proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateWorkstation(NoAwaitTag, google::cloud::workstations::v1::Workstation const &, google::protobuf::FieldMask const &, Options)

Updates an existing workstation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
workstation google::cloud::workstations::v1::Workstation const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.UpdateWorkstationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.Workstation proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateWorkstation(NoAwaitTag, google::cloud::workstations::v1::UpdateWorkstationRequest const &, Options)

Updates an existing workstation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::workstations::v1::UpdateWorkstationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateWorkstation(google::longrunning::Operation const &, Options)

Updates an existing workstation.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::workstations::v1::Workstation > >

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.Workstation proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteWorkstation(NoAwaitTag, std::string const &, Options)

Deletes the specified workstation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.DeleteWorkstationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.Workstation proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteWorkstation(NoAwaitTag, google::cloud::workstations::v1::DeleteWorkstationRequest const &, Options)

Deletes the specified workstation.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::workstations::v1::DeleteWorkstationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteWorkstation(google::longrunning::Operation const &, Options)

Deletes the specified workstation.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::workstations::v1::Workstation > >

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.Workstation proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StartWorkstation(NoAwaitTag, std::string const &, Options)

Starts running a workstation so that users can connect to it.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.StartWorkstationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.Workstation proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StartWorkstation(NoAwaitTag, google::cloud::workstations::v1::StartWorkstationRequest const &, Options)

Starts running a workstation so that users can connect to it.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::workstations::v1::StartWorkstationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

StartWorkstation(google::longrunning::Operation const &, Options)

Starts running a workstation so that users can connect to it.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::workstations::v1::Workstation > >

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.Workstation proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StopWorkstation(NoAwaitTag, std::string const &, Options)

Stops running a workstation, reducing costs.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.StopWorkstationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.workstations.v1.Workstation proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StopWorkstation(NoAwaitTag, google::cloud::workstations::v1::StopWorkstationRequest const &, Options)

Stops running a workstation, reducing costs.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::workstations::v1::StopWorkstationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

StopWorkstation(google::longrunning::Operation const &, Options)

Stops running a workstation, reducing costs.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::workstations::v1::Workstation > >

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.workstations.v1.GenerateAccessTokenRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 StatusOr contains the error details.

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Sets the access control policy on the specified resource.

Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name Description
request google::iam::v1::SetIamPolicyRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::iam::v1::Policy >

the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

Gets the access control policy for a resource.

Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name Description
request google::iam::v1::GetIamPolicyRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::iam::v1::Policy >

the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

Returns permissions that a caller has on the specified resource.

If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name Description
request google::iam::v1::TestIamPermissionsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::iam::v1::TestIamPermissionsResponse >

the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListOperations(std::string const &, std::string const &, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation's parent resource.

filter std::string const &

The standard list filter.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::longrunning::Operation >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListOperations(google::longrunning::ListOperationsRequest, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::ListOperationsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.ListOperationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::longrunning::Operation >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
name std::string const &

The name of the operation resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::longrunning::Operation >

the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
request google::longrunning::GetOperationRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.GetOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::longrunning::Operation >

the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be deleted.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::DeleteOperationRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.DeleteOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be cancelled.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

CancelOperation(google::longrunning::CancelOperationRequest const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request google::longrunning::CancelOperationRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.CancelOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.