Reference documentation and code samples for the AI Platform Notebooks V1 API class Google::Cloud::Notebooks::V1::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
#create_environment
def create_environment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_environment REST call
- request_pb (::Google::Cloud::Notebooks::V1::CreateEnvironmentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_execution
def create_execution(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_execution REST call
- request_pb (::Google::Cloud::Notebooks::V1::CreateExecutionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_instance
def create_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_instance REST call
- request_pb (::Google::Cloud::Notebooks::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_schedule
def create_schedule(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_schedule REST call
- request_pb (::Google::Cloud::Notebooks::V1::CreateScheduleRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_environment
def delete_environment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_environment REST call
- request_pb (::Google::Cloud::Notebooks::V1::DeleteEnvironmentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_execution
def delete_execution(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_execution REST call
- request_pb (::Google::Cloud::Notebooks::V1::DeleteExecutionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_instance
def delete_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_instance REST call
- request_pb (::Google::Cloud::Notebooks::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_schedule
def delete_schedule(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_schedule REST call
- request_pb (::Google::Cloud::Notebooks::V1::DeleteScheduleRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#diagnose_instance
def diagnose_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the diagnose_instance REST call
- request_pb (::Google::Cloud::Notebooks::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#endpoint
def endpoint() -> String
The effective endpoint
- (String)
#get_environment
def get_environment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V1::Environment
Baseline implementation for the get_environment REST call
- request_pb (::Google::Cloud::Notebooks::V1::GetEnvironmentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Notebooks::V1::Environment)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Notebooks::V1::Environment) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_execution
def get_execution(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V1::Execution
Baseline implementation for the get_execution REST call
- request_pb (::Google::Cloud::Notebooks::V1::GetExecutionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Notebooks::V1::Execution)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Notebooks::V1::Execution) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_instance
def get_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V1::Instance
Baseline implementation for the get_instance REST call
- request_pb (::Google::Cloud::Notebooks::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Notebooks::V1::Instance)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Notebooks::V1::Instance) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_instance_health
def get_instance_health(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V1::GetInstanceHealthResponse
Baseline implementation for the get_instance_health REST call
- request_pb (::Google::Cloud::Notebooks::V1::GetInstanceHealthRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Notebooks::V1::GetInstanceHealthResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Notebooks::V1::GetInstanceHealthResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_schedule
def get_schedule(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V1::Schedule
Baseline implementation for the get_schedule REST call
- request_pb (::Google::Cloud::Notebooks::V1::GetScheduleRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Notebooks::V1::Schedule)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Notebooks::V1::Schedule) — A result object deserialized from the server's reply
- (::ArgumentError)
#is_instance_upgradeable
def is_instance_upgradeable(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V1::IsInstanceUpgradeableResponse
Baseline implementation for the is_instance_upgradeable REST call
- request_pb (::Google::Cloud::Notebooks::V1::IsInstanceUpgradeableRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Notebooks::V1::IsInstanceUpgradeableResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Notebooks::V1::IsInstanceUpgradeableResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_environments
def list_environments(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V1::ListEnvironmentsResponse
Baseline implementation for the list_environments REST call
- request_pb (::Google::Cloud::Notebooks::V1::ListEnvironmentsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Notebooks::V1::ListEnvironmentsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Notebooks::V1::ListEnvironmentsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_executions
def list_executions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V1::ListExecutionsResponse
Baseline implementation for the list_executions REST call
- request_pb (::Google::Cloud::Notebooks::V1::ListExecutionsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Notebooks::V1::ListExecutionsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Notebooks::V1::ListExecutionsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_instances
def list_instances(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V1::ListInstancesResponse
Baseline implementation for the list_instances REST call
- request_pb (::Google::Cloud::Notebooks::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Notebooks::V1::ListInstancesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Notebooks::V1::ListInstancesResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_schedules
def list_schedules(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V1::ListSchedulesResponse
Baseline implementation for the list_schedules REST call
- request_pb (::Google::Cloud::Notebooks::V1::ListSchedulesRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Notebooks::V1::ListSchedulesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Notebooks::V1::ListSchedulesResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#logger
def logger(stub: false) -> Logger
The logger used for request/response debug logging.
- (Logger)
#register_instance
def register_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the register_instance REST call
- request_pb (::Google::Cloud::Notebooks::V1::RegisterInstanceRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#report_instance_info
def report_instance_info(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the report_instance_info REST call
- request_pb (::Google::Cloud::Notebooks::V1::ReportInstanceInfoRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#reset_instance
def reset_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the reset_instance REST call
- request_pb (::Google::Cloud::Notebooks::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#rollback_instance
def rollback_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the rollback_instance REST call
- request_pb (::Google::Cloud::Notebooks::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#set_instance_accelerator
def set_instance_accelerator(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the set_instance_accelerator REST call
- request_pb (::Google::Cloud::Notebooks::V1::SetInstanceAcceleratorRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#set_instance_labels
def set_instance_labels(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the set_instance_labels REST call
- request_pb (::Google::Cloud::Notebooks::V1::SetInstanceLabelsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#set_instance_machine_type
def set_instance_machine_type(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the set_instance_machine_type REST call
- request_pb (::Google::Cloud::Notebooks::V1::SetInstanceMachineTypeRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#start_instance
def start_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the start_instance REST call
- request_pb (::Google::Cloud::Notebooks::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#stop_instance
def stop_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the stop_instance REST call
- request_pb (::Google::Cloud::Notebooks::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#trigger_schedule
def trigger_schedule(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the trigger_schedule REST call
- request_pb (::Google::Cloud::Notebooks::V1::TriggerScheduleRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_instance_config
def update_instance_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_instance_config REST call
- request_pb (::Google::Cloud::Notebooks::V1::UpdateInstanceConfigRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_instance_metadata_items
def update_instance_metadata_items(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsResponse
Baseline implementation for the update_instance_metadata_items REST call
- request_pb (::Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_shielded_instance_config
def update_shielded_instance_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_shielded_instance_config REST call
- request_pb (::Google::Cloud::Notebooks::V1::UpdateShieldedInstanceConfigRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#upgrade_instance
def upgrade_instance(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the upgrade_instance REST call
- request_pb (::Google::Cloud::Notebooks::V1::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#upgrade_instance_internal
def upgrade_instance_internal(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the upgrade_instance_internal REST call
- request_pb (::Google::Cloud::Notebooks::V1::UpgradeInstanceInternalRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)