# Notebooks V2 API - Class Google::Cloud::Notebooks::V2::NotebookService::Rest::Client (v1.5.0)

1.5.0 (latest) 1.4.0 1.3.1 1.2.0 1.1.0 1.0.1 0.6.0 0.5.0 0.4.2 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::Client.

REST client for the NotebookService service.


<br />

API v2 service for Workbench Notebooks Instances.

## Inherits

- Object

## Includes

- [Google::Cloud::Notebooks::V2::NotebookService::Paths](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-NotebookService-Paths)

## Methods

### .configure

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

Configure the NotebookService Client class.


<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-NotebookService-Rest-Client-Configuration "Google::Cloud::Notebooks::V2::NotebookService::Rest::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-NotebookService-Rest-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-NotebookService-Rest-Client-Configuration))
**Example**

```ruby
# Modify the configuration for all NotebookService clients
::Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.configure do |config|
  config.timeout = 10.0
end
```

### #check_instance_upgradability

    def check_instance_upgradability(request, options = nil) -> ::Google::Cloud::Notebooks::V2::CheckInstanceUpgradabilityResponse
    def check_instance_upgradability(notebook_instance: nil) -> ::Google::Cloud::Notebooks::V2::CheckInstanceUpgradabilityResponse

Checks whether a notebook instance is upgradable.
**Overloads**

    def check_instance_upgradability(request, options = nil) -> ::Google::Cloud::Notebooks::V2::CheckInstanceUpgradabilityResponse

Pass arguments to `check_instance_upgradability` via a request object, either of type [CheckInstanceUpgradabilityRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-CheckInstanceUpgradabilityRequest "Google::Cloud::Notebooks::V2::CheckInstanceUpgradabilityRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Notebooks::V2::CheckInstanceUpgradabilityRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-CheckInstanceUpgradabilityRequest), ::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 check_instance_upgradability(notebook_instance: nil) -> ::Google::Cloud::Notebooks::V2::CheckInstanceUpgradabilityResponse

Pass arguments to `check_instance_upgradability` 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**

- **notebook_instance** (::String) --- Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Notebooks::V2::CheckInstanceUpgradabilityResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-CheckInstanceUpgradabilityResponse))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Notebooks::V2::CheckInstanceUpgradabilityResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-CheckInstanceUpgradabilityResponse))
**Raises**

- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**

Basic example

```ruby
require "google/cloud/notebooks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Notebooks::V2::CheckInstanceUpgradabilityRequest.new

# Call the check_instance_upgradability method.
result = client.check_instance_upgradability request

# The returned object is of type Google::Cloud::Notebooks::V2::CheckInstanceUpgradabilityResponse.
p result
```

### #configure

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

Configure the NotebookService 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-NotebookService-Rest-Client#Google__Cloud__Notebooks__V2__NotebookService__Rest__Client_configure_class_ "Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.configure (method)").

<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-NotebookService-Rest-Client-Configuration "Google::Cloud::Notebooks::V2::NotebookService::Rest::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-NotebookService-Rest-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-NotebookService-Rest-Client-Configuration))

### #create_instance

    def create_instance(request, options = nil) -> ::Gapic::Operation
    def create_instance(parent: nil, instance_id: nil, instance: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Instance in a given project and location.
**Overloads**

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

Pass arguments to `create_instance` via a request object, either of type [CreateInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-CreateInstanceRequest "Google::Cloud::Notebooks::V2::CreateInstanceRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Notebooks::V2::CreateInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-CreateInstanceRequest), ::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_instance(parent: nil, instance_id: nil, instance: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to `create_instance` 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}`
- **instance_id** (::String) --- Required. User-defined unique ID of this instance.
- **instance** ([::Google::Cloud::Notebooks::V2::Instance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-Instance), ::Hash) --- Required. The instance to be created.
- **request_id** (::String) --- Optional. 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.
**Example**

Basic example

```ruby
require "google/cloud/notebooks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Notebooks::V2::CreateInstanceRequest.new

# Call the create_instance method.
result = client.create_instance request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```

### #delete_instance

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

Deletes a single Instance.
**Overloads**

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

Pass arguments to `delete_instance` via a request object, either of type [DeleteInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-DeleteInstanceRequest "Google::Cloud::Notebooks::V2::DeleteInstanceRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Notebooks::V2::DeleteInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-DeleteInstanceRequest), ::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_instance(name: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to `delete_instance` 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}/instances/{instance_id}`
- **request_id** (::String) --- Optional. 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.
**Example**

Basic example

```ruby
require "google/cloud/notebooks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Notebooks::V2::DeleteInstanceRequest.new

# Call the delete_instance method.
result = client.delete_instance request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```

### #diagnose_instance

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

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
**Overloads**

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

Pass arguments to `diagnose_instance` via a request object, either of type [DiagnoseInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-DiagnoseInstanceRequest "Google::Cloud::Notebooks::V2::DiagnoseInstanceRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Notebooks::V2::DiagnoseInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-DiagnoseInstanceRequest), ::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_instance(name: nil, diagnostic_config: nil, timeout_minutes: nil) -> ::Gapic::Operation

Pass arguments to `diagnose_instance` 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}/instances/{instance_id}`
- **diagnostic_config** ([::Google::Cloud::Notebooks::V2::DiagnosticConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-DiagnosticConfig), ::Hash) --- Required. Defines flags that are used to run the diagnostic tool
- **timeout_minutes** (::Integer) --- Optional. Maxmium amount of time in minutes before the operation times out.
**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.
**Example**

Basic example

```ruby
require "google/cloud/notebooks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Notebooks::V2::DiagnoseInstanceRequest.new

# Call the diagnose_instance method.
result = client.diagnose_instance request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```

### #get_instance

    def get_instance(request, options = nil) -> ::Google::Cloud::Notebooks::V2::Instance
    def get_instance(name: nil) -> ::Google::Cloud::Notebooks::V2::Instance

Gets details of a single Instance.
**Overloads**

    def get_instance(request, options = nil) -> ::Google::Cloud::Notebooks::V2::Instance

Pass arguments to `get_instance` via a request object, either of type [GetInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-GetInstanceRequest "Google::Cloud::Notebooks::V2::GetInstanceRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Notebooks::V2::GetInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-GetInstanceRequest), ::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_instance(name: nil) -> ::Google::Cloud::Notebooks::V2::Instance

Pass arguments to `get_instance` 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}/instances/{instance_id}`
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Notebooks::V2::Instance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-Instance))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Notebooks::V2::Instance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-Instance))
**Raises**

- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**

Basic example

```ruby
require "google/cloud/notebooks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Notebooks::V2::GetInstanceRequest.new

# Call the get_instance method.
result = client.get_instance request

# The returned object is of type Google::Cloud::Notebooks::V2::Instance.
p result
```

### #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 NotebookService REST client object.
**Yields**

- (config) --- Configure the NotebookService client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-NotebookService-Rest-Client-Configuration))
**Returns**

- ([Client](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-NotebookService-Rest-Client)) --- a new instance of Client
**Example**

```ruby
# Create a client using the default configuration
client = ::Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.new

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

### #list_instances

    def list_instances(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V2::Instance>
    def list_instances(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V2::Instance>

Lists instances in a given project and location.
**Overloads**

    def list_instances(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V2::Instance>

Pass arguments to `list_instances` via a request object, either of type [ListInstancesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-ListInstancesRequest "Google::Cloud::Notebooks::V2::ListInstancesRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Notebooks::V2::ListInstancesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-ListInstancesRequest), ::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_instances(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Notebooks::V2::Instance>

Pass arguments to `list_instances` 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) --- Optional. Maximum return size of the list call.
- **page_token** (::String) --- Optional. A previous returned page token that can be used to continue listing from the last result.
- **order_by** (::String) --- Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
- **filter** (::String) --- Optional. List filter.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** (::Gapic::Rest::PagedEnumerable\<[::Google::Cloud::Notebooks::V2::Instance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-Instance)\>)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- (::Gapic::Rest::PagedEnumerable\<[::Google::Cloud::Notebooks::V2::Instance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-Instance)\>)
**Raises**

- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**

Basic example

```ruby
require "google/cloud/notebooks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Notebooks::V2::ListInstancesRequest.new

# Call the list_instances method.
result = client.list_instances request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Notebooks::V2::Instance.
  p item
end
```

### #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)

### #logger

    def logger() -> Logger

The logger used for request/response debug logging.
**Returns**

- (Logger)

### #operations_client

    def operations_client() -> ::Google::Cloud::Notebooks::V2::NotebookService::Rest::Operations

Get the associated client for long-running operations.
**Returns**

- ([::Google::Cloud::Notebooks::V2::NotebookService::Rest::Operations](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-NotebookService-Rest-Operations))

### #reset_instance

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

Resets a notebook instance.
**Overloads**

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

Pass arguments to `reset_instance` via a request object, either of type [ResetInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-ResetInstanceRequest "Google::Cloud::Notebooks::V2::ResetInstanceRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Notebooks::V2::ResetInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-ResetInstanceRequest), ::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_instance(name: nil) -> ::Gapic::Operation

Pass arguments to `reset_instance` 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}/instances/{instance_id}`
**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.
**Example**

Basic example

```ruby
require "google/cloud/notebooks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Notebooks::V2::ResetInstanceRequest.new

# Call the reset_instance method.
result = client.reset_instance request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```

### #rollback_instance

    def rollback_instance(request, options = nil) -> ::Gapic::Operation
    def rollback_instance(name: nil, target_snapshot: nil) -> ::Gapic::Operation

Rollbacks a notebook instance to the previous version.
**Overloads**

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

Pass arguments to `rollback_instance` via a request object, either of type [RollbackInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-RollbackInstanceRequest "Google::Cloud::Notebooks::V2::RollbackInstanceRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Notebooks::V2::RollbackInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-RollbackInstanceRequest), ::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 rollback_instance(name: nil, target_snapshot: nil) -> ::Gapic::Operation

Pass arguments to `rollback_instance` 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}/instances/{instance_id}`
- **target_snapshot** (::String) --- Required. The snapshot for rollback. Example: "projects/test-project/global/snapshots/krwlzipynril".
**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.
**Example**

Basic example

```ruby
require "google/cloud/notebooks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Notebooks::V2::RollbackInstanceRequest.new

# Call the rollback_instance method.
result = client.rollback_instance request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```

### #start_instance

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

Starts a notebook instance.
**Overloads**

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

Pass arguments to `start_instance` via a request object, either of type [StartInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-StartInstanceRequest "Google::Cloud::Notebooks::V2::StartInstanceRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Notebooks::V2::StartInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-StartInstanceRequest), ::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_instance(name: nil) -> ::Gapic::Operation

Pass arguments to `start_instance` 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}/instances/{instance_id}`
**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.
**Example**

Basic example

```ruby
require "google/cloud/notebooks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Notebooks::V2::StartInstanceRequest.new

# Call the start_instance method.
result = client.start_instance request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```

### #stop_instance

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

Stops a notebook instance.
**Overloads**

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

Pass arguments to `stop_instance` via a request object, either of type [StopInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-StopInstanceRequest "Google::Cloud::Notebooks::V2::StopInstanceRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Notebooks::V2::StopInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-StopInstanceRequest), ::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_instance(name: nil) -> ::Gapic::Operation

Pass arguments to `stop_instance` 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}/instances/{instance_id}`
**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.
**Example**

Basic example

```ruby
require "google/cloud/notebooks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Notebooks::V2::StopInstanceRequest.new

# Call the stop_instance method.
result = client.stop_instance request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```

### #universe_domain

    def universe_domain() -> String

The effective universe domain
**Returns**

- (String)

### #update_instance

    def update_instance(request, options = nil) -> ::Gapic::Operation
    def update_instance(instance: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

UpdateInstance updates an Instance.
**Overloads**

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

Pass arguments to `update_instance` via a request object, either of type [UpdateInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-UpdateInstanceRequest "Google::Cloud::Notebooks::V2::UpdateInstanceRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Notebooks::V2::UpdateInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-UpdateInstanceRequest), ::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_instance(instance: nil, update_mask: nil, request_id: nil) -> ::Gapic::Operation

Pass arguments to `update_instance` 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**

- **instance** ([::Google::Cloud::Notebooks::V2::Instance](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-Instance), ::Hash) --- Required. A representation of an instance.
- **update_mask** ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Protobuf-FieldMask), ::Hash) --- Required. Mask used to update an instance
- **request_id** (::String) --- Optional. 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.
**Example**

Basic example

```ruby
require "google/cloud/notebooks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Notebooks::V2::UpdateInstanceRequest.new

# Call the update_instance method.
result = client.update_instance request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```

### #upgrade_instance

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

Upgrades a notebook instance to the latest version.
**Overloads**

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

Pass arguments to `upgrade_instance` via a request object, either of type [UpgradeInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-UpgradeInstanceRequest "Google::Cloud::Notebooks::V2::UpgradeInstanceRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Notebooks::V2::UpgradeInstanceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-notebooks-v2/latest/Google-Cloud-Notebooks-V2-UpgradeInstanceRequest), ::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_instance(name: nil) -> ::Gapic::Operation

Pass arguments to `upgrade_instance` 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}/instances/{instance_id}`
**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.
**Example**

Basic example

```ruby
require "google/cloud/notebooks/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Notebooks::V2::NotebookService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Notebooks::V2::UpgradeInstanceRequest.new

# Call the upgrade_instance method.
result = client.upgrade_instance request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end
```