Notebooks V2 API - Class Google::Cloud::Notebooks::V2::NotebookService::Rest::ServiceStub (v0.2.0)

Version 0.2.0

• 0.4.2 (latest)
• 0.4.1
• 0.3.2
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Notebooks V2 API class Google::Cloud::Notebooks::V2::NotebookService::Rest::ServiceStub.

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

Inherits

• Object

Methods

#check_instance_upgradability

def check_instance_upgradability(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V2::CheckInstanceUpgradabilityResponse

Baseline implementation for the check_instance_upgradability REST call

Parameters

• request_pb (::Google::Cloud::Notebooks::V2::CheckInstanceUpgradabilityRequest) — 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::Notebooks::V2::CheckInstanceUpgradabilityResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Notebooks::V2::CheckInstanceUpgradabilityResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_instance

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

Baseline implementation for the create_instance REST call

Parameters

• request_pb (::Google::Cloud::Notebooks::V2::CreateInstanceRequest) — 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_instance

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

Baseline implementation for the delete_instance REST call

Parameters

• request_pb (::Google::Cloud::Notebooks::V2::DeleteInstanceRequest) — 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)

#diagnose_instance

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

Baseline implementation for the diagnose_instance REST call

Parameters

• request_pb (::Google::Cloud::Notebooks::V2::DiagnoseInstanceRequest) — 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)

#get_instance

def get_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V2::Instance

Baseline implementation for the get_instance REST call

Parameters

• request_pb (::Google::Cloud::Notebooks::V2::GetInstanceRequest) — 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::Notebooks::V2::Instance)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Notebooks::V2::Instance) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

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

Returns

• (ServiceStub) — a new instance of ServiceStub

#list_instances

def list_instances(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V2::ListInstancesResponse

Baseline implementation for the list_instances REST call

Parameters

• request_pb (::Google::Cloud::Notebooks::V2::ListInstancesRequest) — 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::Notebooks::V2::ListInstancesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Notebooks::V2::ListInstancesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#reset_instance

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

Baseline implementation for the reset_instance REST call

Parameters

• request_pb (::Google::Cloud::Notebooks::V2::ResetInstanceRequest) — 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)

#rollback_instance

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

Baseline implementation for the rollback_instance REST call

Parameters

• request_pb (::Google::Cloud::Notebooks::V2::RollbackInstanceRequest) — 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)

#start_instance

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

Baseline implementation for the start_instance REST call

Parameters

• request_pb (::Google::Cloud::Notebooks::V2::StartInstanceRequest) — 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_instance

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

Baseline implementation for the stop_instance REST call

Parameters

• request_pb (::Google::Cloud::Notebooks::V2::StopInstanceRequest) — 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_instance

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

Baseline implementation for the update_instance REST call

Parameters

• request_pb (::Google::Cloud::Notebooks::V2::UpdateInstanceRequest) — 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)

#upgrade_instance

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

Baseline implementation for the upgrade_instance REST call

Parameters

• request_pb (::Google::Cloud::Notebooks::V2::UpgradeInstanceRequest) — 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)