Cloud AI Platform v1 API - Class TensorboardService.TensorboardServiceBase (2.19.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

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
NameDescription
requestBatchCreateTensorboardRunsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestBatchCreateTensorboardTimeSeriesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestBatchReadTensorboardTimeSeriesDataRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestCreateTensorboardRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestCreateTensorboardExperimentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestCreateTensorboardRunRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestCreateTensorboardTimeSeriesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestDeleteTensorboardRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestDeleteTensorboardExperimentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestDeleteTensorboardRunRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestDeleteTensorboardTimeSeriesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestExportTensorboardTimeSeriesDataRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestGetTensorboardRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestGetTensorboardExperimentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestGetTensorboardRunRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestGetTensorboardTimeSeriesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestListTensorboardExperimentsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestListTensorboardRunsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListTensorboardRunsResponse

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
NameDescription
requestListTensorboardsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListTensorboardsResponse

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
NameDescription
requestListTensorboardTimeSeriesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListTensorboardTimeSeriesResponse

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
NameDescription
requestReadTensorboardBlobDataRequest

The request received from the client.

responseStreamIServerStreamWriterReadTensorboardBlobDataResponse

Used for sending responses back to the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestReadTensorboardSizeRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestReadTensorboardTimeSeriesDataRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestReadTensorboardUsageRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestUpdateTensorboardRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestUpdateTensorboardExperimentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestUpdateTensorboardRunRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestUpdateTensorboardTimeSeriesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestWriteTensorboardExperimentDataRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
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
NameDescription
requestWriteTensorboardRunDataRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskWriteTensorboardRunDataResponse

The response to send back to the client (wrapped by a task).