Interface TensorboardServiceGrpc.AsyncService (3.48.0)

public static interface TensorboardServiceGrpc.AsyncService

TensorboardService

Methods

batchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest request, StreamObserver<BatchCreateTensorboardRunsResponse> responseObserver)

public default void batchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest request, StreamObserver<BatchCreateTensorboardRunsResponse> responseObserver)

Batch create TensorboardRuns.

Parameters
Name Description
request BatchCreateTensorboardRunsRequest
responseObserver io.grpc.stub.StreamObserver<BatchCreateTensorboardRunsResponse>

batchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request, StreamObserver<BatchCreateTensorboardTimeSeriesResponse> responseObserver)

public default void batchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request, StreamObserver<BatchCreateTensorboardTimeSeriesResponse> responseObserver)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
Name Description
request BatchCreateTensorboardTimeSeriesRequest
responseObserver io.grpc.stub.StreamObserver<BatchCreateTensorboardTimeSeriesResponse>

batchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest request, StreamObserver<BatchReadTensorboardTimeSeriesDataResponse> responseObserver)

public default void batchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest request, StreamObserver<BatchReadTensorboardTimeSeriesDataResponse> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<BatchReadTensorboardTimeSeriesDataResponse>

createTensorboard(CreateTensorboardRequest request, StreamObserver<Operation> responseObserver)

public default void createTensorboard(CreateTensorboardRequest request, StreamObserver<Operation> responseObserver)

Creates a Tensorboard.

Parameters
Name Description
request CreateTensorboardRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createTensorboardExperiment(CreateTensorboardExperimentRequest request, StreamObserver<TensorboardExperiment> responseObserver)

public default void createTensorboardExperiment(CreateTensorboardExperimentRequest request, StreamObserver<TensorboardExperiment> responseObserver)

Creates a TensorboardExperiment.

Parameters
Name Description
request CreateTensorboardExperimentRequest
responseObserver io.grpc.stub.StreamObserver<TensorboardExperiment>

createTensorboardRun(CreateTensorboardRunRequest request, StreamObserver<TensorboardRun> responseObserver)

public default void createTensorboardRun(CreateTensorboardRunRequest request, StreamObserver<TensorboardRun> responseObserver)

Creates a TensorboardRun.

Parameters
Name Description
request CreateTensorboardRunRequest
responseObserver io.grpc.stub.StreamObserver<TensorboardRun>

createTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request, StreamObserver<TensorboardTimeSeries> responseObserver)

public default void createTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request, StreamObserver<TensorboardTimeSeries> responseObserver)

Creates a TensorboardTimeSeries.

Parameters
Name Description
request CreateTensorboardTimeSeriesRequest
responseObserver io.grpc.stub.StreamObserver<TensorboardTimeSeries>

deleteTensorboard(DeleteTensorboardRequest request, StreamObserver<Operation> responseObserver)

public default void deleteTensorboard(DeleteTensorboardRequest request, StreamObserver<Operation> responseObserver)

Deletes a Tensorboard.

Parameters
Name Description
request DeleteTensorboardRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteTensorboardExperiment(DeleteTensorboardExperimentRequest request, StreamObserver<Operation> responseObserver)

public default void deleteTensorboardExperiment(DeleteTensorboardExperimentRequest request, StreamObserver<Operation> responseObserver)

Deletes a TensorboardExperiment.

Parameters
Name Description
request DeleteTensorboardExperimentRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteTensorboardRun(DeleteTensorboardRunRequest request, StreamObserver<Operation> responseObserver)

public default void deleteTensorboardRun(DeleteTensorboardRunRequest request, StreamObserver<Operation> responseObserver)

Deletes a TensorboardRun.

Parameters
Name Description
request DeleteTensorboardRunRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest request, StreamObserver<Operation> responseObserver)

public default void deleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest request, StreamObserver<Operation> responseObserver)

Deletes a TensorboardTimeSeries.

Parameters
Name Description
request DeleteTensorboardTimeSeriesRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

exportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request, StreamObserver<ExportTensorboardTimeSeriesDataResponse> responseObserver)

public default void exportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request, StreamObserver<ExportTensorboardTimeSeriesDataResponse> responseObserver)

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

Parameters
Name Description
request ExportTensorboardTimeSeriesDataRequest
responseObserver io.grpc.stub.StreamObserver<ExportTensorboardTimeSeriesDataResponse>

getTensorboard(GetTensorboardRequest request, StreamObserver<Tensorboard> responseObserver)

public default void getTensorboard(GetTensorboardRequest request, StreamObserver<Tensorboard> responseObserver)

Gets a Tensorboard.

Parameters
Name Description
request GetTensorboardRequest
responseObserver io.grpc.stub.StreamObserver<Tensorboard>

getTensorboardExperiment(GetTensorboardExperimentRequest request, StreamObserver<TensorboardExperiment> responseObserver)

public default void getTensorboardExperiment(GetTensorboardExperimentRequest request, StreamObserver<TensorboardExperiment> responseObserver)

Gets a TensorboardExperiment.

Parameters
Name Description
request GetTensorboardExperimentRequest
responseObserver io.grpc.stub.StreamObserver<TensorboardExperiment>

getTensorboardRun(GetTensorboardRunRequest request, StreamObserver<TensorboardRun> responseObserver)

public default void getTensorboardRun(GetTensorboardRunRequest request, StreamObserver<TensorboardRun> responseObserver)

Gets a TensorboardRun.

Parameters
Name Description
request GetTensorboardRunRequest
responseObserver io.grpc.stub.StreamObserver<TensorboardRun>

getTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request, StreamObserver<TensorboardTimeSeries> responseObserver)

public default void getTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request, StreamObserver<TensorboardTimeSeries> responseObserver)

Gets a TensorboardTimeSeries.

Parameters
Name Description
request GetTensorboardTimeSeriesRequest
responseObserver io.grpc.stub.StreamObserver<TensorboardTimeSeries>

listTensorboardExperiments(ListTensorboardExperimentsRequest request, StreamObserver<ListTensorboardExperimentsResponse> responseObserver)

public default void listTensorboardExperiments(ListTensorboardExperimentsRequest request, StreamObserver<ListTensorboardExperimentsResponse> responseObserver)

Lists TensorboardExperiments in a Location.

Parameters
Name Description
request ListTensorboardExperimentsRequest
responseObserver io.grpc.stub.StreamObserver<ListTensorboardExperimentsResponse>

listTensorboardRuns(ListTensorboardRunsRequest request, StreamObserver<ListTensorboardRunsResponse> responseObserver)

public default void listTensorboardRuns(ListTensorboardRunsRequest request, StreamObserver<ListTensorboardRunsResponse> responseObserver)

Lists TensorboardRuns in a Location.

Parameters
Name Description
request ListTensorboardRunsRequest
responseObserver io.grpc.stub.StreamObserver<ListTensorboardRunsResponse>

listTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request, StreamObserver<ListTensorboardTimeSeriesResponse> responseObserver)

public default void listTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request, StreamObserver<ListTensorboardTimeSeriesResponse> responseObserver)

Lists TensorboardTimeSeries in a Location.

Parameters
Name Description
request ListTensorboardTimeSeriesRequest
responseObserver io.grpc.stub.StreamObserver<ListTensorboardTimeSeriesResponse>

listTensorboards(ListTensorboardsRequest request, StreamObserver<ListTensorboardsResponse> responseObserver)

public default void listTensorboards(ListTensorboardsRequest request, StreamObserver<ListTensorboardsResponse> responseObserver)

Lists Tensorboards in a Location.

Parameters
Name Description
request ListTensorboardsRequest
responseObserver io.grpc.stub.StreamObserver<ListTensorboardsResponse>

readTensorboardBlobData(ReadTensorboardBlobDataRequest request, StreamObserver<ReadTensorboardBlobDataResponse> responseObserver)

public default void readTensorboardBlobData(ReadTensorboardBlobDataRequest request, StreamObserver<ReadTensorboardBlobDataResponse> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<ReadTensorboardBlobDataResponse>

readTensorboardSize(ReadTensorboardSizeRequest request, StreamObserver<ReadTensorboardSizeResponse> responseObserver)

public default void readTensorboardSize(ReadTensorboardSizeRequest request, StreamObserver<ReadTensorboardSizeResponse> responseObserver)

Returns the storage size for a given TensorBoard instance.

Parameters
Name Description
request ReadTensorboardSizeRequest
responseObserver io.grpc.stub.StreamObserver<ReadTensorboardSizeResponse>

readTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest request, StreamObserver<ReadTensorboardTimeSeriesDataResponse> responseObserver)

public default void readTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest request, StreamObserver<ReadTensorboardTimeSeriesDataResponse> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<ReadTensorboardTimeSeriesDataResponse>

readTensorboardUsage(ReadTensorboardUsageRequest request, StreamObserver<ReadTensorboardUsageResponse> responseObserver)

public default void readTensorboardUsage(ReadTensorboardUsageRequest request, StreamObserver<ReadTensorboardUsageResponse> responseObserver)

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

Parameters
Name Description
request ReadTensorboardUsageRequest
responseObserver io.grpc.stub.StreamObserver<ReadTensorboardUsageResponse>

updateTensorboard(UpdateTensorboardRequest request, StreamObserver<Operation> responseObserver)

public default void updateTensorboard(UpdateTensorboardRequest request, StreamObserver<Operation> responseObserver)

Updates a Tensorboard.

Parameters
Name Description
request UpdateTensorboardRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateTensorboardExperiment(UpdateTensorboardExperimentRequest request, StreamObserver<TensorboardExperiment> responseObserver)

public default void updateTensorboardExperiment(UpdateTensorboardExperimentRequest request, StreamObserver<TensorboardExperiment> responseObserver)

Updates a TensorboardExperiment.

Parameters
Name Description
request UpdateTensorboardExperimentRequest
responseObserver io.grpc.stub.StreamObserver<TensorboardExperiment>

updateTensorboardRun(UpdateTensorboardRunRequest request, StreamObserver<TensorboardRun> responseObserver)

public default void updateTensorboardRun(UpdateTensorboardRunRequest request, StreamObserver<TensorboardRun> responseObserver)

Updates a TensorboardRun.

Parameters
Name Description
request UpdateTensorboardRunRequest
responseObserver io.grpc.stub.StreamObserver<TensorboardRun>

updateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request, StreamObserver<TensorboardTimeSeries> responseObserver)

public default void updateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request, StreamObserver<TensorboardTimeSeries> responseObserver)

Updates a TensorboardTimeSeries.

Parameters
Name Description
request UpdateTensorboardTimeSeriesRequest
responseObserver io.grpc.stub.StreamObserver<TensorboardTimeSeries>

writeTensorboardExperimentData(WriteTensorboardExperimentDataRequest request, StreamObserver<WriteTensorboardExperimentDataResponse> responseObserver)

public default void writeTensorboardExperimentData(WriteTensorboardExperimentDataRequest request, StreamObserver<WriteTensorboardExperimentDataResponse> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<WriteTensorboardExperimentDataResponse>

writeTensorboardRunData(WriteTensorboardRunDataRequest request, StreamObserver<WriteTensorboardRunDataResponse> responseObserver)

public default void writeTensorboardRunData(WriteTensorboardRunDataRequest request, StreamObserver<WriteTensorboardRunDataResponse> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<WriteTensorboardRunDataResponse>