AI Platform Notebooks V1 API - Class Google::Cloud::Notebooks::V1::ManagedNotebookService::Rest::Client (v0.5.0)

Reference documentation and code samples for the AI Platform Notebooks V1 API class Google::Cloud::Notebooks::V1::ManagedNotebookService::Rest::Client.

REST client for the ManagedNotebookService service.

API v1 service for Managed Notebooks.

Inherits

Object

Includes

Google::Cloud::Notebooks::V1::ManagedNotebookService::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the ManagedNotebookService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all ManagedNotebookService clients
::Google::Cloud::Notebooks::V1::ManagedNotebookService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the ManagedNotebookService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_runtime

def create_runtime(request, options = nil) -> ::Gapic::Operation
def create_runtime(parent: nil, runtime_id: nil, runtime: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Runtime in a given project and location.

Overloads

def create_runtime(request, options = nil) -> ::Gapic::Operation

Pass arguments to create_runtime via a request object, either of type CreateRuntimeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Notebooks::V1::CreateRuntimeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_runtime(parent: nil, runtime_id: nil, runtime: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to create_runtime via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. Format: parent=projects/{project_id}/locations/{location}
runtime_id (::String) — Required. User-defined unique ID of this Runtime.
runtime (::Google::Cloud::Notebooks::V1::Runtime, ::Hash) — Required. The Runtime to be created.
request_id (::String) — Idempotent request UUID.

Yields

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

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#delete_runtime

def delete_runtime(request, options = nil) -> ::Gapic::Operation
def delete_runtime(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single Runtime.

Overloads

def delete_runtime(request, options = nil) -> ::Gapic::Operation

Pass arguments to delete_runtime via a request object, either of type DeleteRuntimeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Notebooks::V1::DeleteRuntimeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_runtime(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to delete_runtime via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
request_id (::String) — Idempotent request UUID.

Yields

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

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#diagnose_runtime

def diagnose_runtime(request, options = nil) -> ::Gapic::Operation
def diagnose_runtime(name: nil, diagnostic_config: nil) -> ::Gapic::Operation

Creates a Diagnostic File and runs Diagnostic Tool given a Runtime.

Overloads

def diagnose_runtime(request, options = nil) -> ::Gapic::Operation

Pass arguments to diagnose_runtime via a request object, either of type DiagnoseRuntimeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Notebooks::V1::DiagnoseRuntimeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def diagnose_runtime(name: nil, diagnostic_config: nil) -> ::Gapic::Operation

Pass arguments to diagnose_runtime via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtimes_id}
diagnostic_config (::Google::Cloud::Notebooks::V1::DiagnosticConfig, ::Hash) — Required. Defines flags that are used to run the diagnostic tool

Yields

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

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#get_runtime

def get_runtime(request, options = nil) -> ::Google::Cloud::Notebooks::V1::Runtime
def get_runtime(name: nil) -> ::Google::Cloud::Notebooks::V1::Runtime

Gets details of a single Runtime. The location must be a regional endpoint rather than zonal.

Overloads

def get_runtime(request, options = nil) -> ::Google::Cloud::Notebooks::V1::Runtime

Pass arguments to get_runtime via a request object, either of type GetRuntimeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Notebooks::V1::GetRuntimeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_runtime(name: nil) -> ::Google::Cloud::Notebooks::V1::Runtime

Pass arguments to get_runtime via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}

Yields

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

Yield Parameters

result (::Google::Cloud::Notebooks::V1::Runtime)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Notebooks::V1::Runtime)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Rest::Client

Get the associated client for mix-in of the IAMPolicy.

Returns

(Google::Iam::V1::IAMPolicy::Rest::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new ManagedNotebookService REST client object.

Yields

(config) — Configure the ManagedNotebookService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_runtimes

def list_runtimes(request, options = nil) -> ::Google::Cloud::Notebooks::V1::ListRuntimesResponse
def list_runtimes(parent: nil, page_size: nil, page_token: nil) -> ::Google::Cloud::Notebooks::V1::ListRuntimesResponse

Lists Runtimes in a given project and location.

Overloads

def list_runtimes(request, options = nil) -> ::Google::Cloud::Notebooks::V1::ListRuntimesResponse

Pass arguments to list_runtimes via a request object, either of type ListRuntimesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Notebooks::V1::ListRuntimesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_runtimes(parent: nil, page_size: nil, page_token: nil) -> ::Google::Cloud::Notebooks::V1::ListRuntimesResponse

Pass arguments to list_runtimes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. Format: parent=projects/{project_id}/locations/{location}
page_size (::Integer) — Maximum return size of the list call.
page_token (::String) — A previous returned page token that can be used to continue listing from the last result.

Yields

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

Yield Parameters

result (::Google::Cloud::Notebooks::V1::ListRuntimesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Notebooks::V1::ListRuntimesResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns

(Google::Cloud::Location::Locations::Rest::Client)

#operations_client

def operations_client() -> ::Google::Cloud::Notebooks::V1::ManagedNotebookService::Rest::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::Notebooks::V1::ManagedNotebookService::Rest::Operations)

#refresh_runtime_token_internal

def refresh_runtime_token_internal(request, options = nil) -> ::Google::Cloud::Notebooks::V1::RefreshRuntimeTokenInternalResponse
def refresh_runtime_token_internal(name: nil, vm_id: nil) -> ::Google::Cloud::Notebooks::V1::RefreshRuntimeTokenInternalResponse

Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance.

Overloads

def refresh_runtime_token_internal(request, options = nil) -> ::Google::Cloud::Notebooks::V1::RefreshRuntimeTokenInternalResponse

Pass arguments to refresh_runtime_token_internal via a request object, either of type RefreshRuntimeTokenInternalRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Notebooks::V1::RefreshRuntimeTokenInternalRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def refresh_runtime_token_internal(name: nil, vm_id: nil) -> ::Google::Cloud::Notebooks::V1::RefreshRuntimeTokenInternalResponse

Pass arguments to refresh_runtime_token_internal via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
vm_id (::String) — Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity

Yields

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

Yield Parameters

result (::Google::Cloud::Notebooks::V1::RefreshRuntimeTokenInternalResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Notebooks::V1::RefreshRuntimeTokenInternalResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#report_runtime_event

def report_runtime_event(request, options = nil) -> ::Gapic::Operation
def report_runtime_event(name: nil, vm_id: nil, event: nil) -> ::Gapic::Operation

Report and process a runtime event.

Overloads

def report_runtime_event(request, options = nil) -> ::Gapic::Operation

Pass arguments to report_runtime_event via a request object, either of type ReportRuntimeEventRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Notebooks::V1::ReportRuntimeEventRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def report_runtime_event(name: nil, vm_id: nil, event: nil) -> ::Gapic::Operation

Pass arguments to report_runtime_event via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
vm_id (::String) — Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
event (::Google::Cloud::Notebooks::V1::Event, ::Hash) — Required. The Event to be reported.

Yields

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

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#reset_runtime

def reset_runtime(request, options = nil) -> ::Gapic::Operation
def reset_runtime(name: nil, request_id: nil) -> ::Gapic::Operation

Resets a Managed Notebook Runtime.

Overloads

def reset_runtime(request, options = nil) -> ::Gapic::Operation

Pass arguments to reset_runtime via a request object, either of type ResetRuntimeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Notebooks::V1::ResetRuntimeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def reset_runtime(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to reset_runtime via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
request_id (::String) — Idempotent request UUID.

Yields

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

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#start_runtime

def start_runtime(request, options = nil) -> ::Gapic::Operation
def start_runtime(name: nil, request_id: nil) -> ::Gapic::Operation

Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Overloads

def start_runtime(request, options = nil) -> ::Gapic::Operation

Pass arguments to start_runtime via a request object, either of type StartRuntimeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Notebooks::V1::StartRuntimeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def start_runtime(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to start_runtime via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
request_id (::String) — Idempotent request UUID.

Yields

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

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#stop_runtime

def stop_runtime(request, options = nil) -> ::Gapic::Operation
def stop_runtime(name: nil, request_id: nil) -> ::Gapic::Operation

Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance

Overloads

def stop_runtime(request, options = nil) -> ::Gapic::Operation

Pass arguments to stop_runtime via a request object, either of type StopRuntimeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Notebooks::V1::StopRuntimeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def stop_runtime(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to stop_runtime via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
request_id (::String) — Idempotent request UUID.

Yields

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

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#switch_runtime

def switch_runtime(request, options = nil) -> ::Gapic::Operation
def switch_runtime(name: nil, machine_type: nil, accelerator_config: nil, request_id: nil) -> ::Gapic::Operation

Switch a Managed Notebook Runtime.

Overloads

def switch_runtime(request, options = nil) -> ::Gapic::Operation

Pass arguments to switch_runtime via a request object, either of type SwitchRuntimeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Notebooks::V1::SwitchRuntimeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def switch_runtime(name: nil, machine_type: nil, accelerator_config: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to switch_runtime via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
machine_type (::String) — machine type.
accelerator_config (::Google::Cloud::Notebooks::V1::RuntimeAcceleratorConfig, ::Hash) — accelerator config.
request_id (::String) — Idempotent request UUID.

Yields

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

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#update_runtime

def update_runtime(request, options = nil) -> ::Gapic::Operation
def update_runtime(runtime: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Update Notebook Runtime configuration.

Overloads

def update_runtime(request, options = nil) -> ::Gapic::Operation

Pass arguments to update_runtime via a request object, either of type UpdateRuntimeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Notebooks::V1::UpdateRuntimeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_runtime(runtime: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to update_runtime via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

runtime (::Google::Cloud::Notebooks::V1::Runtime, ::Hash) — Required. The Runtime to be updated.
update_mask (::Google::Protobuf::FieldMask, ::Hash) —
Required. Specifies the path, relative to Runtime, of the field to update. For example, to change the software configuration kernels, the update_mask parameter would be specified as software_config.kernels, and the PATCH request body would specify the new value, as follows:
```
{
  "software_config":{
    "kernels": [{
       'repository':
       'gcr.io/deeplearning-platform-release/pytorch-gpu', 'tag':
       'latest' }],
    }
}
```
Currently, only the following fields can be updated:
- software_config.kernels
- software_config.post_startup_script
- software_config.custom_gpu_driver_path
- software_config.idle_shutdown
- software_config.idle_shutdown_timeout
- software_config.disable_terminal
request_id (::String) — Idempotent request UUID.

Yields

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

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#upgrade_runtime

def upgrade_runtime(request, options = nil) -> ::Gapic::Operation
def upgrade_runtime(name: nil, request_id: nil) -> ::Gapic::Operation

Upgrades a Managed Notebook Runtime to the latest version.

Overloads

def upgrade_runtime(request, options = nil) -> ::Gapic::Operation

Pass arguments to upgrade_runtime via a request object, either of type UpgradeRuntimeRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Notebooks::V1::UpgradeRuntimeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def upgrade_runtime(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to upgrade_runtime via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. Format: projects/{project_id}/locations/{location}/runtimes/{runtime_id}
request_id (::String) — Idempotent request UUID.

Yields

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

Yield Parameters

result (::Gapic::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.