Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::TensorboardService::Rest::ServiceStub (v0.42.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::TensorboardService::Rest::ServiceStub.

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

Inherits

  • Object

Methods

#batch_create_tensorboard_runs

def batch_create_tensorboard_runs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsResponse

Baseline implementation for the batch_create_tensorboard_runs REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#batch_create_tensorboard_time_series

def batch_create_tensorboard_time_series(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesResponse

Baseline implementation for the batch_create_tensorboard_time_series REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#batch_read_tensorboard_time_series_data

def batch_read_tensorboard_time_series_data(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataResponse

Baseline implementation for the batch_read_tensorboard_time_series_data REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_tensorboard

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

Baseline implementation for the create_tensorboard REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_tensorboard_experiment

def create_tensorboard_experiment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment

Baseline implementation for the create_tensorboard_experiment REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_tensorboard_run

def create_tensorboard_run(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::TensorboardRun

Baseline implementation for the create_tensorboard_run REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_tensorboard_time_series

def create_tensorboard_time_series(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries

Baseline implementation for the create_tensorboard_time_series REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_tensorboard

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

Baseline implementation for the delete_tensorboard REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_tensorboard_experiment

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

Baseline implementation for the delete_tensorboard_experiment REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_tensorboard_run

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

Baseline implementation for the delete_tensorboard_run REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_tensorboard_time_series

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

Baseline implementation for the delete_tensorboard_time_series REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#export_tensorboard_time_series_data

def export_tensorboard_time_series_data(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::ExportTensorboardTimeSeriesDataResponse

Baseline implementation for the export_tensorboard_time_series_data REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_tensorboard

def get_tensorboard(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::Tensorboard

Baseline implementation for the get_tensorboard REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_tensorboard_experiment

def get_tensorboard_experiment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment

Baseline implementation for the get_tensorboard_experiment REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_tensorboard_run

def get_tensorboard_run(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::TensorboardRun

Baseline implementation for the get_tensorboard_run REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_tensorboard_time_series

def get_tensorboard_time_series(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries

Baseline implementation for the get_tensorboard_time_series REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
Returns

#list_tensorboard_experiments

def list_tensorboard_experiments(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::ListTensorboardExperimentsResponse

Baseline implementation for the list_tensorboard_experiments REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_tensorboard_runs

def list_tensorboard_runs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::ListTensorboardRunsResponse

Baseline implementation for the list_tensorboard_runs REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_tensorboard_time_series

def list_tensorboard_time_series(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::ListTensorboardTimeSeriesResponse

Baseline implementation for the list_tensorboard_time_series REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_tensorboards

def list_tensorboards(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::ListTensorboardsResponse

Baseline implementation for the list_tensorboards REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#read_tensorboard_blob_data

def read_tensorboard_blob_data(request_pb, options = nil, &block) { |chunk| ... } -> ::Gapic::Rest::TransportOperation

Baseline implementation for the read_tensorboard_blob_data REST call

Parameters
Yield Parameter
  • chunk (::String) — The chunk of data received during server streaming.
Returns
  • (::Gapic::Rest::TransportOperation)
Raises
  • (::ArgumentError)

#read_tensorboard_size

def read_tensorboard_size(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardSizeResponse

Baseline implementation for the read_tensorboard_size REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#read_tensorboard_time_series_data

def read_tensorboard_time_series_data(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataResponse

Baseline implementation for the read_tensorboard_time_series_data REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#read_tensorboard_usage

def read_tensorboard_usage(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse

Baseline implementation for the read_tensorboard_usage REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_tensorboard

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

Baseline implementation for the update_tensorboard REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_tensorboard_experiment

def update_tensorboard_experiment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment

Baseline implementation for the update_tensorboard_experiment REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_tensorboard_run

def update_tensorboard_run(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::TensorboardRun

Baseline implementation for the update_tensorboard_run REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_tensorboard_time_series

def update_tensorboard_time_series(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries

Baseline implementation for the update_tensorboard_time_series REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#write_tensorboard_experiment_data

def write_tensorboard_experiment_data(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataResponse

Baseline implementation for the write_tensorboard_experiment_data REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#write_tensorboard_run_data

def write_tensorboard_run_data(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataResponse

Baseline implementation for the write_tensorboard_run_data REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)