Cloud Workstations V1BETA API - Class Google::Cloud::Workstations::V1beta::Workstations::Rest::ServiceStub (v0.1.2)

Reference documentation and code samples for the Cloud Workstations V1BETA API class Google::Cloud::Workstations::V1beta::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::V1beta::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::V1beta::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::V1beta::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::V1beta::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::V1beta::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::V1beta::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::V1beta::GenerateAccessTokenResponse

Baseline implementation for the generate_access_token REST call

Parameters

request_pb (::Google::Cloud::Workstations::V1beta::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::V1beta::GenerateAccessTokenResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Workstations::V1beta::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::V1beta::Workstation

Baseline implementation for the get_workstation REST call

Parameters

request_pb (::Google::Cloud::Workstations::V1beta::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::V1beta::Workstation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Workstations::V1beta::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::V1beta::WorkstationCluster

Baseline implementation for the get_workstation_cluster REST call

Parameters

request_pb (::Google::Cloud::Workstations::V1beta::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::V1beta::WorkstationCluster)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Workstations::V1beta::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::V1beta::WorkstationConfig

Baseline implementation for the get_workstation_config REST call

Parameters

request_pb (::Google::Cloud::Workstations::V1beta::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::V1beta::WorkstationConfig)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Workstations::V1beta::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::V1beta::ListUsableWorkstationConfigsResponse

Baseline implementation for the list_usable_workstation_configs REST call

Parameters

request_pb (::Google::Cloud::Workstations::V1beta::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::V1beta::ListUsableWorkstationConfigsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Workstations::V1beta::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::V1beta::ListUsableWorkstationsResponse

Baseline implementation for the list_usable_workstations REST call

Parameters

request_pb (::Google::Cloud::Workstations::V1beta::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::V1beta::ListUsableWorkstationsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Workstations::V1beta::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::V1beta::ListWorkstationClustersResponse

Baseline implementation for the list_workstation_clusters REST call

Parameters

request_pb (::Google::Cloud::Workstations::V1beta::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::V1beta::ListWorkstationClustersResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Workstations::V1beta::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::V1beta::ListWorkstationConfigsResponse

Baseline implementation for the list_workstation_configs REST call

Parameters

request_pb (::Google::Cloud::Workstations::V1beta::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::V1beta::ListWorkstationConfigsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Workstations::V1beta::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::V1beta::ListWorkstationsResponse

Baseline implementation for the list_workstations REST call

Parameters

request_pb (::Google::Cloud::Workstations::V1beta::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::V1beta::ListWorkstationsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Workstations::V1beta::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::V1beta::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::V1beta::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::V1beta::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::V1beta::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::V1beta::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)