Cloud Workstations V1 API - Class Google::Cloud::Workstations::V1::Workstations::Rest::ServiceStub (v0.1.1)

Version 0.1.1

• 0.1.2 (latest)
• 0.1.1

Reference documentation and code samples for the Cloud Workstations V1 API class Google::Cloud::Workstations::V1::Workstations::Rest::ServiceStub.

REST service stub for the Workstations service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

• Object

Methods

#create_workstation

def create_workstation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_workstation REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::CreateWorkstationRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_workstation_cluster

def create_workstation_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_workstation_cluster REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::CreateWorkstationClusterRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_workstation_config

def create_workstation_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_workstation_config REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::CreateWorkstationConfigRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_workstation

def delete_workstation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_workstation REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::DeleteWorkstationRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_workstation_cluster

def delete_workstation_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_workstation_cluster REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::DeleteWorkstationClusterRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_workstation_config

def delete_workstation_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_workstation_config REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::DeleteWorkstationConfigRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#generate_access_token

def generate_access_token(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Workstations::V1::GenerateAccessTokenResponse

Baseline implementation for the generate_access_token REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::GenerateAccessTokenRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Workstations::V1::GenerateAccessTokenResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Workstations::V1::GenerateAccessTokenResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_workstation

def get_workstation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Workstations::V1::Workstation

Baseline implementation for the get_workstation REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::GetWorkstationRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Workstations::V1::Workstation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Workstations::V1::Workstation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_workstation_cluster

def get_workstation_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Workstations::V1::WorkstationCluster

Baseline implementation for the get_workstation_cluster REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::GetWorkstationClusterRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Workstations::V1::WorkstationCluster)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Workstations::V1::WorkstationCluster) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_workstation_config

def get_workstation_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Workstations::V1::WorkstationConfig

Baseline implementation for the get_workstation_config REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::GetWorkstationConfigRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Workstations::V1::WorkstationConfig)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Workstations::V1::WorkstationConfig) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

• (ServiceStub) — a new instance of ServiceStub

#list_usable_workstation_configs

def list_usable_workstation_configs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Workstations::V1::ListUsableWorkstationConfigsResponse

Baseline implementation for the list_usable_workstation_configs REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::ListUsableWorkstationConfigsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Workstations::V1::ListUsableWorkstationConfigsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Workstations::V1::ListUsableWorkstationConfigsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_usable_workstations

def list_usable_workstations(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Workstations::V1::ListUsableWorkstationsResponse

Baseline implementation for the list_usable_workstations REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::ListUsableWorkstationsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Workstations::V1::ListUsableWorkstationsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Workstations::V1::ListUsableWorkstationsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_workstation_clusters

def list_workstation_clusters(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Workstations::V1::ListWorkstationClustersResponse

Baseline implementation for the list_workstation_clusters REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::ListWorkstationClustersRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Workstations::V1::ListWorkstationClustersResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Workstations::V1::ListWorkstationClustersResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_workstation_configs

def list_workstation_configs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Workstations::V1::ListWorkstationConfigsResponse

Baseline implementation for the list_workstation_configs REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::ListWorkstationConfigsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Workstations::V1::ListWorkstationConfigsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Workstations::V1::ListWorkstationConfigsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_workstations

def list_workstations(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Workstations::V1::ListWorkstationsResponse

Baseline implementation for the list_workstations REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::ListWorkstationsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Workstations::V1::ListWorkstationsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Workstations::V1::ListWorkstationsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#start_workstation

def start_workstation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the start_workstation REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::StartWorkstationRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#stop_workstation

def stop_workstation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the stop_workstation REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::StopWorkstationRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_workstation

def update_workstation(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_workstation REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::UpdateWorkstationRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#update_workstation_cluster

def update_workstation_cluster(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_workstation_cluster REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::UpdateWorkstationClusterRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#update_workstation_config

def update_workstation_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_workstation_config REST call

Parameters

• request_pb (::Google::Cloud::Workstations::V1::UpdateWorkstationConfigRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)