Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::TensorboardService::Client (v0.57.0)

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

Client for the TensorboardService service.

TensorboardService

Inherits

Object

Includes

Google::Cloud::AIPlatform::V1::TensorboardService::Paths

Methods

.configure

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

Configure the TensorboardService 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 TensorboardService clients
::Google::Cloud::AIPlatform::V1::TensorboardService::Client.configure do |config|
  config.timeout = 10.0
end

#batch_create_tensorboard_runs

def batch_create_tensorboard_runs(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsResponse
def batch_create_tensorboard_runs(parent: nil, requests: nil) -> ::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsResponse

Batch create TensorboardRuns.

Overloads

def batch_create_tensorboard_runs(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsResponse

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

Parameters

request (::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsRequest, ::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 batch_create_tensorboard_runs(parent: nil, requests: nil) -> ::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsResponse

Pass arguments to batch_create_tensorboard_runs 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. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} The parent field in the CreateTensorboardRunRequest messages must match this field.
requests (::Array<::Google::Cloud::AIPlatform::V1::CreateTensorboardRunRequest, ::Hash>) — Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsResponse)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::BatchCreateTensorboardRunsResponse.
p result

#batch_create_tensorboard_time_series

def batch_create_tensorboard_time_series(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesResponse
def batch_create_tensorboard_time_series(parent: nil, requests: nil) -> ::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesResponse

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Overloads

def batch_create_tensorboard_time_series(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesResponse

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

Parameters

request (::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesRequest, ::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 batch_create_tensorboard_time_series(parent: nil, requests: nil) -> ::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesResponse

Pass arguments to batch_create_tensorboard_time_series 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. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.
requests (::Array<::Google::Cloud::AIPlatform::V1::CreateTensorboardTimeSeriesRequest, ::Hash>) — Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesResponse)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::BatchCreateTensorboardTimeSeriesResponse.
p result

#batch_read_tensorboard_time_series_data

def batch_read_tensorboard_time_series_data(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataResponse
def batch_read_tensorboard_time_series_data(tensorboard: nil, time_series: nil) -> ::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataResponse

Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.

Overloads

def batch_read_tensorboard_time_series_data(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataResponse

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

Parameters

request (::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataRequest, ::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 batch_read_tensorboard_time_series_data(tensorboard: nil, time_series: nil) -> ::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataResponse

Pass arguments to batch_read_tensorboard_time_series_data 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

tensorboard (::String) — Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.
time_series (::Array<::String>) — Required. The resource names of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataResponse)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::BatchReadTensorboardTimeSeriesDataResponse.
p result

#configure

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

Configure the TensorboardService 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_tensorboard

def create_tensorboard(request, options = nil) -> ::Gapic::Operation
def create_tensorboard(parent: nil, tensorboard: nil) -> ::Gapic::Operation

Creates a Tensorboard.

Overloads

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

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

Parameters

request (::Google::Cloud::AIPlatform::V1::CreateTensorboardRequest, ::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_tensorboard(parent: nil, tensorboard: nil) -> ::Gapic::Operation

Pass arguments to create_tensorboard 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. The resource name of the Location to create the Tensorboard in. Format: projects/{project}/locations/{location}
tensorboard (::Google::Cloud::AIPlatform::V1::Tensorboard, ::Hash) — Required. The Tensorboard to create.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CreateTensorboardRequest.new

# Call the create_tensorboard method.
result = client.create_tensorboard 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

#create_tensorboard_experiment

def create_tensorboard_experiment(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment
def create_tensorboard_experiment(parent: nil, tensorboard_experiment: nil, tensorboard_experiment_id: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment

Creates a TensorboardExperiment.

Overloads

def create_tensorboard_experiment(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment

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

Parameters

request (::Google::Cloud::AIPlatform::V1::CreateTensorboardExperimentRequest, ::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_tensorboard_experiment(parent: nil, tensorboard_experiment: nil, tensorboard_experiment_id: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment

Pass arguments to create_tensorboard_experiment 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. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
tensorboard_experiment (::Google::Cloud::AIPlatform::V1::TensorboardExperiment, ::Hash) — The TensorboardExperiment to create.
tensorboard_experiment_id (::String) — Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::TensorboardExperiment)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::TensorboardExperiment)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CreateTensorboardExperimentRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardExperiment.
p result

#create_tensorboard_run

def create_tensorboard_run(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardRun
def create_tensorboard_run(parent: nil, tensorboard_run: nil, tensorboard_run_id: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardRun

Creates a TensorboardRun.

Overloads

def create_tensorboard_run(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardRun

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

Parameters

request (::Google::Cloud::AIPlatform::V1::CreateTensorboardRunRequest, ::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_tensorboard_run(parent: nil, tensorboard_run: nil, tensorboard_run_id: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardRun

Pass arguments to create_tensorboard_run 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. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
tensorboard_run (::Google::Cloud::AIPlatform::V1::TensorboardRun, ::Hash) — Required. The TensorboardRun to create.
tensorboard_run_id (::String) — Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::TensorboardRun)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::TensorboardRun)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CreateTensorboardRunRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardRun.
p result

#create_tensorboard_time_series

def create_tensorboard_time_series(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries
def create_tensorboard_time_series(parent: nil, tensorboard_time_series_id: nil, tensorboard_time_series: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries

Creates a TensorboardTimeSeries.

Overloads

def create_tensorboard_time_series(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries

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

Parameters

request (::Google::Cloud::AIPlatform::V1::CreateTensorboardTimeSeriesRequest, ::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_tensorboard_time_series(parent: nil, tensorboard_time_series_id: nil, tensorboard_time_series: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries

Pass arguments to create_tensorboard_time_series 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. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
tensorboard_time_series_id (::String) — Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "[a-z0-9][a-z0-9-]{0, 127}"
tensorboard_time_series (::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries, ::Hash) — Required. The TensorboardTimeSeries to create.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CreateTensorboardTimeSeriesRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardTimeSeries.
p result

#delete_tensorboard

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

Deletes a Tensorboard.

Overloads

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

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

Parameters

request (::Google::Cloud::AIPlatform::V1::DeleteTensorboardRequest, ::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_tensorboard(name: nil) -> ::Gapic::Operation

Pass arguments to delete_tensorboard 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. The name of the Tensorboard to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::DeleteTensorboardRequest.new

# Call the delete_tensorboard method.
result = client.delete_tensorboard 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_tensorboard_experiment

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

Deletes a TensorboardExperiment.

Overloads

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

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

Parameters

request (::Google::Cloud::AIPlatform::V1::DeleteTensorboardExperimentRequest, ::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_tensorboard_experiment(name: nil) -> ::Gapic::Operation

Pass arguments to delete_tensorboard_experiment 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. The name of the TensorboardExperiment to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::DeleteTensorboardExperimentRequest.new

# Call the delete_tensorboard_experiment method.
result = client.delete_tensorboard_experiment 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_tensorboard_run

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

Deletes a TensorboardRun.

Overloads

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

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

Parameters

request (::Google::Cloud::AIPlatform::V1::DeleteTensorboardRunRequest, ::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_tensorboard_run(name: nil) -> ::Gapic::Operation

Pass arguments to delete_tensorboard_run 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. The name of the TensorboardRun to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::DeleteTensorboardRunRequest.new

# Call the delete_tensorboard_run method.
result = client.delete_tensorboard_run 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_tensorboard_time_series

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

Deletes a TensorboardTimeSeries.

Overloads

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

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

Parameters

request (::Google::Cloud::AIPlatform::V1::DeleteTensorboardTimeSeriesRequest, ::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_tensorboard_time_series(name: nil) -> ::Gapic::Operation

Pass arguments to delete_tensorboard_time_series 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. The name of the TensorboardTimeSeries to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::DeleteTensorboardTimeSeriesRequest.new

# Call the delete_tensorboard_time_series method.
result = client.delete_tensorboard_time_series 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

#export_tensorboard_time_series_data

def export_tensorboard_time_series_data(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TimeSeriesDataPoint>
def export_tensorboard_time_series_data(tensorboard_time_series: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TimeSeriesDataPoint>

Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.

Overloads

def export_tensorboard_time_series_data(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TimeSeriesDataPoint>

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

Parameters

request (::Google::Cloud::AIPlatform::V1::ExportTensorboardTimeSeriesDataRequest, ::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 export_tensorboard_time_series_data(tensorboard_time_series: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TimeSeriesDataPoint>

Pass arguments to export_tensorboard_time_series_data 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

tensorboard_time_series (::String) — Required. The resource name of the TensorboardTimeSeries to export data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}
filter (::String) — Exports the TensorboardTimeSeries' data that match the filter expression.
page_size (::Integer) — The maximum number of data points to return per page. The default page_size is 1000. Values must be between 1 and 10000. Values above 10000 are coerced to 10000.
page_token (::String) — A page token, received from a previous ExportTensorboardTimeSeriesData call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ExportTensorboardTimeSeriesData must match the call that provided the page token.
order_by (::String) — Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data is returned in a pseudo random order.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TimeSeriesDataPoint>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TimeSeriesDataPoint>)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ExportTensorboardTimeSeriesDataRequest.new

# Call the export_tensorboard_time_series_data method.
result = client.export_tensorboard_time_series_data 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::AIPlatform::V1::TimeSeriesDataPoint.
  p item
end

#get_tensorboard

def get_tensorboard(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::Tensorboard
def get_tensorboard(name: nil) -> ::Google::Cloud::AIPlatform::V1::Tensorboard

Gets a Tensorboard.

Overloads

def get_tensorboard(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::Tensorboard

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

Parameters

request (::Google::Cloud::AIPlatform::V1::GetTensorboardRequest, ::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_tensorboard(name: nil) -> ::Google::Cloud::AIPlatform::V1::Tensorboard

Pass arguments to get_tensorboard 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. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::Tensorboard)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::Tensorboard)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GetTensorboardRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::Tensorboard.
p result

#get_tensorboard_experiment

def get_tensorboard_experiment(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment
def get_tensorboard_experiment(name: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment

Gets a TensorboardExperiment.

Overloads

def get_tensorboard_experiment(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment

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

Parameters

request (::Google::Cloud::AIPlatform::V1::GetTensorboardExperimentRequest, ::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_tensorboard_experiment(name: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment

Pass arguments to get_tensorboard_experiment 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. The name of the TensorboardExperiment resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::TensorboardExperiment)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::TensorboardExperiment)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GetTensorboardExperimentRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardExperiment.
p result

#get_tensorboard_run

def get_tensorboard_run(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardRun
def get_tensorboard_run(name: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardRun

Gets a TensorboardRun.

Overloads

def get_tensorboard_run(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardRun

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

Parameters

request (::Google::Cloud::AIPlatform::V1::GetTensorboardRunRequest, ::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_tensorboard_run(name: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardRun

Pass arguments to get_tensorboard_run 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. The name of the TensorboardRun resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::TensorboardRun)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::TensorboardRun)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GetTensorboardRunRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardRun.
p result

#get_tensorboard_time_series

def get_tensorboard_time_series(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries
def get_tensorboard_time_series(name: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries

Gets a TensorboardTimeSeries.

Overloads

def get_tensorboard_time_series(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries

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

Parameters

request (::Google::Cloud::AIPlatform::V1::GetTensorboardTimeSeriesRequest, ::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_tensorboard_time_series(name: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries

Pass arguments to get_tensorboard_time_series 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. The name of the TensorboardTimeSeries resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::GetTensorboardTimeSeriesRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardTimeSeries.
p result

#iam_policy_client

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

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

Returns

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

#initialize

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

Create a new TensorboardService client object.

Yields

(config) — Configure the TensorboardService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

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

#list_tensorboard_experiments

def list_tensorboard_experiments(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardExperiment>
def list_tensorboard_experiments(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardExperiment>

Lists TensorboardExperiments in a Location.

Overloads

def list_tensorboard_experiments(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardExperiment>

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

Parameters

request (::Google::Cloud::AIPlatform::V1::ListTensorboardExperimentsRequest, ::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_tensorboard_experiments(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardExperiment>

Pass arguments to list_tensorboard_experiments 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. The resource name of the Tensorboard to list TensorboardExperiments. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
filter (::String) — Lists the TensorboardExperiments that match the filter expression.
page_size (::Integer) — The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
page_token (::String) — A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.
order_by (::String) — Field to use to sort the list.
read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardExperiment>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardExperiment>)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ListTensorboardExperimentsRequest.new

# Call the list_tensorboard_experiments method.
result = client.list_tensorboard_experiments 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::AIPlatform::V1::TensorboardExperiment.
  p item
end

#list_tensorboard_runs

def list_tensorboard_runs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardRun>
def list_tensorboard_runs(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardRun>

Lists TensorboardRuns in a Location.

Overloads

def list_tensorboard_runs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardRun>

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

Parameters

request (::Google::Cloud::AIPlatform::V1::ListTensorboardRunsRequest, ::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_tensorboard_runs(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardRun>

Pass arguments to list_tensorboard_runs 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. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
filter (::String) — Lists the TensorboardRuns that match the filter expression.
page_size (::Integer) — The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
page_token (::String) — A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.
order_by (::String) — Field to use to sort the list.
read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardRun>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardRun>)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ListTensorboardRunsRequest.new

# Call the list_tensorboard_runs method.
result = client.list_tensorboard_runs 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::AIPlatform::V1::TensorboardRun.
  p item
end

#list_tensorboard_time_series

def list_tensorboard_time_series(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries>
def list_tensorboard_time_series(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries>

Lists TensorboardTimeSeries in a Location.

Overloads

def list_tensorboard_time_series(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries>

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

Parameters

request (::Google::Cloud::AIPlatform::V1::ListTensorboardTimeSeriesRequest, ::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_tensorboard_time_series(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries>

Pass arguments to list_tensorboard_time_series 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. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
filter (::String) — Lists the TensorboardTimeSeries that match the filter expression.
page_size (::Integer) — The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
page_token (::String) — A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.
order_by (::String) — Field to use to sort the list.
read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries>)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ListTensorboardTimeSeriesRequest.new

# Call the list_tensorboard_time_series method.
result = client.list_tensorboard_time_series 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::AIPlatform::V1::TensorboardTimeSeries.
  p item
end

#list_tensorboards

def list_tensorboards(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Tensorboard>
def list_tensorboards(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Tensorboard>

Lists Tensorboards in a Location.

Overloads

def list_tensorboards(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Tensorboard>

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

Parameters

request (::Google::Cloud::AIPlatform::V1::ListTensorboardsRequest, ::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_tensorboards(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, read_mask: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Tensorboard>

Pass arguments to list_tensorboards 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. The resource name of the Location to list Tensorboards. Format: projects/{project}/locations/{location}
filter (::String) — Lists the Tensorboards that match the filter expression.
page_size (::Integer) — The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.
page_token (::String) — A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.
order_by (::String) — Field to use to sort the list.
read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Tensorboard>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Tensorboard>)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ListTensorboardsRequest.new

# Call the list_tensorboards method.
result = client.list_tensorboards 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::AIPlatform::V1::Tensorboard.
  p item
end

#location_client

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

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

Returns

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

#operations_client

def operations_client() -> ::Google::Cloud::AIPlatform::V1::TensorboardService::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::AIPlatform::V1::TensorboardService::Operations)

#read_tensorboard_blob_data

def read_tensorboard_blob_data(request, options = nil) -> ::Enumerable<::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataResponse>
def read_tensorboard_blob_data(time_series: nil, blob_ids: nil) -> ::Enumerable<::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataResponse>

Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.

Overloads

def read_tensorboard_blob_data(request, options = nil) -> ::Enumerable<::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataResponse>

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

Parameters

request (::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataRequest, ::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 read_tensorboard_blob_data(time_series: nil, blob_ids: nil) -> ::Enumerable<::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataResponse>

Pass arguments to read_tensorboard_blob_data 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

time_series (::String) — Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}
blob_ids (::Array<::String>) — IDs of the blobs to read.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Enumerable<::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataResponse>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Enumerable<::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataResponse>)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataRequest.new

# Call the read_tensorboard_blob_data method to start streaming.
output = client.read_tensorboard_blob_data request

# The returned object is a streamed enumerable yielding elements of type
# ::Google::Cloud::AIPlatform::V1::ReadTensorboardBlobDataResponse
output.each do |current_response|
  p current_response
end

#read_tensorboard_size

def read_tensorboard_size(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardSizeResponse
def read_tensorboard_size(tensorboard: nil) -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardSizeResponse

Returns the storage size for a given TensorBoard instance.

Overloads

def read_tensorboard_size(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardSizeResponse

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

Parameters

request (::Google::Cloud::AIPlatform::V1::ReadTensorboardSizeRequest, ::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 read_tensorboard_size(tensorboard: nil) -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardSizeResponse

Pass arguments to read_tensorboard_size 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

tensorboard (::String) — Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::ReadTensorboardSizeResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::ReadTensorboardSizeResponse)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ReadTensorboardSizeRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::ReadTensorboardSizeResponse.
p result

#read_tensorboard_time_series_data

def read_tensorboard_time_series_data(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataResponse
def read_tensorboard_time_series_data(tensorboard_time_series: nil, max_data_points: nil, filter: nil) -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataResponse

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Overloads

def read_tensorboard_time_series_data(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataResponse

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

Parameters

request (::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataRequest, ::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 read_tensorboard_time_series_data(tensorboard_time_series: nil, max_data_points: nil, filter: nil) -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataResponse

Pass arguments to read_tensorboard_time_series_data 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

tensorboard_time_series (::String) — Required. The resource name of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}
max_data_points (::Integer) — The maximum number of TensorboardTimeSeries' data to return.

This value should be a positive integer. This value can be set to -1 to return all data.
filter (::String) — Reads the TensorboardTimeSeries' data that match the filter expression.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataResponse)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::ReadTensorboardTimeSeriesDataResponse.
p result

#read_tensorboard_usage

def read_tensorboard_usage(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse
def read_tensorboard_usage(tensorboard: nil) -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse

Returns a list of monthly active users for a given TensorBoard instance.

Overloads

def read_tensorboard_usage(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse

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

Parameters

request (::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageRequest, ::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 read_tensorboard_usage(tensorboard: nil) -> ::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse

Pass arguments to read_tensorboard_usage 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

tensorboard (::String) — Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::ReadTensorboardUsageRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::ReadTensorboardUsageResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_tensorboard

def update_tensorboard(request, options = nil) -> ::Gapic::Operation
def update_tensorboard(update_mask: nil, tensorboard: nil) -> ::Gapic::Operation

Updates a Tensorboard.

Overloads

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

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

Parameters

request (::Google::Cloud::AIPlatform::V1::UpdateTensorboardRequest, ::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_tensorboard(update_mask: nil, tensorboard: nil) -> ::Gapic::Operation

Pass arguments to update_tensorboard 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

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.
tensorboard (::Google::Cloud::AIPlatform::V1::Tensorboard, ::Hash) — Required. The Tensorboard's name field is used to identify the Tensorboard to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::UpdateTensorboardRequest.new

# Call the update_tensorboard method.
result = client.update_tensorboard 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

#update_tensorboard_experiment

def update_tensorboard_experiment(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment
def update_tensorboard_experiment(update_mask: nil, tensorboard_experiment: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment

Updates a TensorboardExperiment.

Overloads

def update_tensorboard_experiment(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment

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

Parameters

request (::Google::Cloud::AIPlatform::V1::UpdateTensorboardExperimentRequest, ::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_tensorboard_experiment(update_mask: nil, tensorboard_experiment: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardExperiment

Pass arguments to update_tensorboard_experiment 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

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.
tensorboard_experiment (::Google::Cloud::AIPlatform::V1::TensorboardExperiment, ::Hash) — Required. The TensorboardExperiment's name field is used to identify the TensorboardExperiment to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::TensorboardExperiment)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::TensorboardExperiment)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::UpdateTensorboardExperimentRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardExperiment.
p result

#update_tensorboard_run

def update_tensorboard_run(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardRun
def update_tensorboard_run(update_mask: nil, tensorboard_run: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardRun

Updates a TensorboardRun.

Overloads

def update_tensorboard_run(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardRun

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

Parameters

request (::Google::Cloud::AIPlatform::V1::UpdateTensorboardRunRequest, ::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_tensorboard_run(update_mask: nil, tensorboard_run: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardRun

Pass arguments to update_tensorboard_run 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

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.
tensorboard_run (::Google::Cloud::AIPlatform::V1::TensorboardRun, ::Hash) — Required. The TensorboardRun's name field is used to identify the TensorboardRun to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::TensorboardRun)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::TensorboardRun)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::UpdateTensorboardRunRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardRun.
p result

#update_tensorboard_time_series

def update_tensorboard_time_series(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries
def update_tensorboard_time_series(update_mask: nil, tensorboard_time_series: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries

Updates a TensorboardTimeSeries.

Overloads

def update_tensorboard_time_series(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries

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

Parameters

request (::Google::Cloud::AIPlatform::V1::UpdateTensorboardTimeSeriesRequest, ::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_tensorboard_time_series(update_mask: nil, tensorboard_time_series: nil) -> ::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries

Pass arguments to update_tensorboard_time_series 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

update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.
tensorboard_time_series (::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries, ::Hash) — Required. The TensorboardTimeSeries' name field is used to identify the TensorboardTimeSeries to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::TensorboardTimeSeries)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::UpdateTensorboardTimeSeriesRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::TensorboardTimeSeries.
p result

#write_tensorboard_experiment_data

def write_tensorboard_experiment_data(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataResponse
def write_tensorboard_experiment_data(tensorboard_experiment: nil, write_run_data_requests: nil) -> ::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataResponse

Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.

Overloads

def write_tensorboard_experiment_data(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataResponse

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

Parameters

request (::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataRequest, ::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 write_tensorboard_experiment_data(tensorboard_experiment: nil, write_run_data_requests: nil) -> ::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataResponse

Pass arguments to write_tensorboard_experiment_data 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

tensorboard_experiment (::String) — Required. The resource name of the TensorboardExperiment to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
write_run_data_requests (::Array<::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataRequest, ::Hash>) — Required. Requests containing per-run TensorboardTimeSeries data to write.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataResponse)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::WriteTensorboardExperimentDataResponse.
p result

#write_tensorboard_run_data

def write_tensorboard_run_data(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataResponse
def write_tensorboard_run_data(tensorboard_run: nil, time_series_data: nil) -> ::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataResponse

Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.

Overloads

def write_tensorboard_run_data(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataResponse

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

Parameters

request (::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataRequest, ::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 write_tensorboard_run_data(tensorboard_run: nil, time_series_data: nil) -> ::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataResponse

Pass arguments to write_tensorboard_run_data 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

tensorboard_run (::String) — Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
time_series_data (::Array<::Google::Cloud::AIPlatform::V1::TimeSeriesData, ::Hash>) — Required. The TensorboardTimeSeries data to write. Values with in a time series are indexed by their step value. Repeated writes to the same step will overwrite the existing value for that step. The upper limit of data points per write request is 5000.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataResponse)

Raises

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

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::TensorboardService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::WriteTensorboardRunDataResponse.
p result