Cloud AI Platform v1 API - Class TensorboardService.TensorboardServiceBase (3.4.0)

Version 3.4.0

• 3.10.0 (latest)
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(TensorboardService), "BindService")]
public abstract class TensorboardService.TensorboardServiceBase

Reference documentation and code samples for the Cloud AI Platform v1 API class TensorboardService.TensorboardServiceBase.

Base class for server-side implementations of TensorboardService

Inheritance

object > TensorboardService.TensorboardServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Methods

BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest, ServerCallContext)

public virtual Task<BatchCreateTensorboardRunsResponse> BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest request, ServerCallContext context)

Batch create TensorboardRuns.

Parameters
Name	Description
request	BatchCreateTensorboardRunsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBatchCreateTensorboardRunsResponse	The response to send back to the client (wrapped by a task).

BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest, ServerCallContext)

public virtual Task<BatchCreateTensorboardTimeSeriesResponse> BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request, ServerCallContext context)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
Name	Description
request	BatchCreateTensorboardTimeSeriesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBatchCreateTensorboardTimeSeriesResponse	The response to send back to the client (wrapped by a task).

BatchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest, ServerCallContext)

public virtual Task<BatchReadTensorboardTimeSeriesDataResponse> BatchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	BatchReadTensorboardTimeSeriesDataRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBatchReadTensorboardTimeSeriesDataResponse	The response to send back to the client (wrapped by a task).

CreateTensorboard(CreateTensorboardRequest, ServerCallContext)

public virtual Task<Operation> CreateTensorboard(CreateTensorboardRequest request, ServerCallContext context)

Creates a Tensorboard.

Parameters
Name	Description
request	CreateTensorboardRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateTensorboardExperiment(CreateTensorboardExperimentRequest, ServerCallContext)

public virtual Task<TensorboardExperiment> CreateTensorboardExperiment(CreateTensorboardExperimentRequest request, ServerCallContext context)

Creates a TensorboardExperiment.

Parameters
Name	Description
request	CreateTensorboardExperimentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTensorboardExperiment	The response to send back to the client (wrapped by a task).

CreateTensorboardRun(CreateTensorboardRunRequest, ServerCallContext)

public virtual Task<TensorboardRun> CreateTensorboardRun(CreateTensorboardRunRequest request, ServerCallContext context)

Creates a TensorboardRun.

Parameters
Name	Description
request	CreateTensorboardRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTensorboardRun	The response to send back to the client (wrapped by a task).

CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest, ServerCallContext)

public virtual Task<TensorboardTimeSeries> CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request, ServerCallContext context)

Creates a TensorboardTimeSeries.

Parameters
Name	Description
request	CreateTensorboardTimeSeriesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTensorboardTimeSeries	The response to send back to the client (wrapped by a task).

DeleteTensorboard(DeleteTensorboardRequest, ServerCallContext)

public virtual Task<Operation> DeleteTensorboard(DeleteTensorboardRequest request, ServerCallContext context)

Deletes a Tensorboard.

Parameters
Name	Description
request	DeleteTensorboardRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest, ServerCallContext)

public virtual Task<Operation> DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest request, ServerCallContext context)

Deletes a TensorboardExperiment.

Parameters
Name	Description
request	DeleteTensorboardExperimentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteTensorboardRun(DeleteTensorboardRunRequest, ServerCallContext)

public virtual Task<Operation> DeleteTensorboardRun(DeleteTensorboardRunRequest request, ServerCallContext context)

Deletes a TensorboardRun.

Parameters
Name	Description
request	DeleteTensorboardRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest, ServerCallContext)

public virtual Task<Operation> DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest request, ServerCallContext context)

Deletes a TensorboardTimeSeries.

Parameters
Name	Description
request	DeleteTensorboardTimeSeriesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ExportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest, ServerCallContext)

public virtual Task<ExportTensorboardTimeSeriesDataResponse> ExportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ExportTensorboardTimeSeriesDataRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskExportTensorboardTimeSeriesDataResponse	The response to send back to the client (wrapped by a task).

GetTensorboard(GetTensorboardRequest, ServerCallContext)

public virtual Task<Tensorboard> GetTensorboard(GetTensorboardRequest request, ServerCallContext context)

Gets a Tensorboard.

Parameters
Name	Description
request	GetTensorboardRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTensorboard	The response to send back to the client (wrapped by a task).

GetTensorboardExperiment(GetTensorboardExperimentRequest, ServerCallContext)

public virtual Task<TensorboardExperiment> GetTensorboardExperiment(GetTensorboardExperimentRequest request, ServerCallContext context)

Gets a TensorboardExperiment.

Parameters
Name	Description
request	GetTensorboardExperimentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTensorboardExperiment	The response to send back to the client (wrapped by a task).

GetTensorboardRun(GetTensorboardRunRequest, ServerCallContext)

public virtual Task<TensorboardRun> GetTensorboardRun(GetTensorboardRunRequest request, ServerCallContext context)

Gets a TensorboardRun.

Parameters
Name	Description
request	GetTensorboardRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTensorboardRun	The response to send back to the client (wrapped by a task).

GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest, ServerCallContext)

public virtual Task<TensorboardTimeSeries> GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request, ServerCallContext context)

Gets a TensorboardTimeSeries.

Parameters
Name	Description
request	GetTensorboardTimeSeriesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTensorboardTimeSeries	The response to send back to the client (wrapped by a task).

ListTensorboardExperiments(ListTensorboardExperimentsRequest, ServerCallContext)

public virtual Task<ListTensorboardExperimentsResponse> ListTensorboardExperiments(ListTensorboardExperimentsRequest request, ServerCallContext context)

Lists TensorboardExperiments in a Location.

Parameters
Name	Description
request	ListTensorboardExperimentsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListTensorboardExperimentsResponse	The response to send back to the client (wrapped by a task).

ListTensorboardRuns(ListTensorboardRunsRequest, ServerCallContext)

public virtual Task<ListTensorboardRunsResponse> ListTensorboardRuns(ListTensorboardRunsRequest request, ServerCallContext context)

Lists TensorboardRuns in a Location.

Parameters
Name	Description
request	ListTensorboardRunsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListTensorboardRunsResponse	The response to send back to the client (wrapped by a task).

ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest, ServerCallContext)

public virtual Task<ListTensorboardTimeSeriesResponse> ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request, ServerCallContext context)

Lists TensorboardTimeSeries in a Location.

Parameters
Name	Description
request	ListTensorboardTimeSeriesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListTensorboardTimeSeriesResponse	The response to send back to the client (wrapped by a task).

ListTensorboards(ListTensorboardsRequest, ServerCallContext)

public virtual Task<ListTensorboardsResponse> ListTensorboards(ListTensorboardsRequest request, ServerCallContext context)

Lists Tensorboards in a Location.

Parameters
Name	Description
request	ListTensorboardsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListTensorboardsResponse	The response to send back to the client (wrapped by a task).

ReadTensorboardBlobData(ReadTensorboardBlobDataRequest, IServerStreamWriter<ReadTensorboardBlobDataResponse>, ServerCallContext)

public virtual Task ReadTensorboardBlobData(ReadTensorboardBlobDataRequest request, IServerStreamWriter<ReadTensorboardBlobDataResponse> responseStream, ServerCallContext context)

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.

Parameters
Name	Description
request	ReadTensorboardBlobDataRequest The request received from the client.
responseStream	IServerStreamWriterReadTensorboardBlobDataResponse Used for sending responses back to the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
Task	A task indicating completion of the handler.

ReadTensorboardSize(ReadTensorboardSizeRequest, ServerCallContext)

public virtual Task<ReadTensorboardSizeResponse> ReadTensorboardSize(ReadTensorboardSizeRequest request, ServerCallContext context)

Returns the storage size for a given TensorBoard instance.

Parameters
Name	Description
request	ReadTensorboardSizeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskReadTensorboardSizeResponse	The response to send back to the client (wrapped by a task).

ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest, ServerCallContext)

public virtual Task<ReadTensorboardTimeSeriesDataResponse> ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	ReadTensorboardTimeSeriesDataRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskReadTensorboardTimeSeriesDataResponse	The response to send back to the client (wrapped by a task).

ReadTensorboardUsage(ReadTensorboardUsageRequest, ServerCallContext)

public virtual Task<ReadTensorboardUsageResponse> ReadTensorboardUsage(ReadTensorboardUsageRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ReadTensorboardUsageRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskReadTensorboardUsageResponse	The response to send back to the client (wrapped by a task).

UpdateTensorboard(UpdateTensorboardRequest, ServerCallContext)

public virtual Task<Operation> UpdateTensorboard(UpdateTensorboardRequest request, ServerCallContext context)

Updates a Tensorboard.

Parameters
Name	Description
request	UpdateTensorboardRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest, ServerCallContext)

public virtual Task<TensorboardExperiment> UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest request, ServerCallContext context)

Updates a TensorboardExperiment.

Parameters
Name	Description
request	UpdateTensorboardExperimentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTensorboardExperiment	The response to send back to the client (wrapped by a task).

UpdateTensorboardRun(UpdateTensorboardRunRequest, ServerCallContext)

public virtual Task<TensorboardRun> UpdateTensorboardRun(UpdateTensorboardRunRequest request, ServerCallContext context)

Updates a TensorboardRun.

Parameters
Name	Description
request	UpdateTensorboardRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTensorboardRun	The response to send back to the client (wrapped by a task).

UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest, ServerCallContext)

public virtual Task<TensorboardTimeSeries> UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request, ServerCallContext context)

Updates a TensorboardTimeSeries.

Parameters
Name	Description
request	UpdateTensorboardTimeSeriesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTensorboardTimeSeries	The response to send back to the client (wrapped by a task).

WriteTensorboardExperimentData(WriteTensorboardExperimentDataRequest, ServerCallContext)

public virtual Task<WriteTensorboardExperimentDataResponse> WriteTensorboardExperimentData(WriteTensorboardExperimentDataRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	WriteTensorboardExperimentDataRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskWriteTensorboardExperimentDataResponse	The response to send back to the client (wrapped by a task).

WriteTensorboardRunData(WriteTensorboardRunDataRequest, ServerCallContext)

public virtual Task<WriteTensorboardRunDataResponse> WriteTensorboardRunData(WriteTensorboardRunDataRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	WriteTensorboardRunDataRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskWriteTensorboardRunDataResponse	The response to send back to the client (wrapped by a task).