Class TensorboardServiceGrpc.TensorboardServiceFutureStub (3.33.0)

public static final class TensorboardServiceGrpc.TensorboardServiceFutureStub extends AbstractFutureStub<TensorboardServiceGrpc.TensorboardServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service TensorboardService.

TensorboardService

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > TensorboardServiceGrpc.TensorboardServiceFutureStub

Methods

batchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest request)

public ListenableFuture<BatchCreateTensorboardRunsResponse> batchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest request)

Batch create TensorboardRuns.

Parameter
NameDescription
requestBatchCreateTensorboardRunsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BatchCreateTensorboardRunsResponse>

batchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request)

public ListenableFuture<BatchCreateTensorboardTimeSeriesResponse> batchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameter
NameDescription
requestBatchCreateTensorboardTimeSeriesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BatchCreateTensorboardTimeSeriesResponse>

batchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest request)

public ListenableFuture<BatchReadTensorboardTimeSeriesDataResponse> batchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest request)

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.

Parameter
NameDescription
requestBatchReadTensorboardTimeSeriesDataRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BatchReadTensorboardTimeSeriesDataResponse>

build(Channel channel, CallOptions callOptions)

protected TensorboardServiceGrpc.TensorboardServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
TensorboardServiceGrpc.TensorboardServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createTensorboard(CreateTensorboardRequest request)

public ListenableFuture<Operation> createTensorboard(CreateTensorboardRequest request)

Creates a Tensorboard.

Parameter
NameDescription
requestCreateTensorboardRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

createTensorboardExperiment(CreateTensorboardExperimentRequest request)

public ListenableFuture<TensorboardExperiment> createTensorboardExperiment(CreateTensorboardExperimentRequest request)

Creates a TensorboardExperiment.

Parameter
NameDescription
requestCreateTensorboardExperimentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TensorboardExperiment>

createTensorboardRun(CreateTensorboardRunRequest request)

public ListenableFuture<TensorboardRun> createTensorboardRun(CreateTensorboardRunRequest request)

Creates a TensorboardRun.

Parameter
NameDescription
requestCreateTensorboardRunRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TensorboardRun>

createTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request)

public ListenableFuture<TensorboardTimeSeries> createTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request)

Creates a TensorboardTimeSeries.

Parameter
NameDescription
requestCreateTensorboardTimeSeriesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TensorboardTimeSeries>

deleteTensorboard(DeleteTensorboardRequest request)

public ListenableFuture<Operation> deleteTensorboard(DeleteTensorboardRequest request)

Deletes a Tensorboard.

Parameter
NameDescription
requestDeleteTensorboardRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteTensorboardExperiment(DeleteTensorboardExperimentRequest request)

public ListenableFuture<Operation> deleteTensorboardExperiment(DeleteTensorboardExperimentRequest request)

Deletes a TensorboardExperiment.

Parameter
NameDescription
requestDeleteTensorboardExperimentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteTensorboardRun(DeleteTensorboardRunRequest request)

public ListenableFuture<Operation> deleteTensorboardRun(DeleteTensorboardRunRequest request)

Deletes a TensorboardRun.

Parameter
NameDescription
requestDeleteTensorboardRunRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest request)

public ListenableFuture<Operation> deleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest request)

Deletes a TensorboardTimeSeries.

Parameter
NameDescription
requestDeleteTensorboardTimeSeriesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

exportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request)

public ListenableFuture<ExportTensorboardTimeSeriesDataResponse> exportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request)

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

Parameter
NameDescription
requestExportTensorboardTimeSeriesDataRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ExportTensorboardTimeSeriesDataResponse>

getTensorboard(GetTensorboardRequest request)

public ListenableFuture<Tensorboard> getTensorboard(GetTensorboardRequest request)

Gets a Tensorboard.

Parameter
NameDescription
requestGetTensorboardRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Tensorboard>

getTensorboardExperiment(GetTensorboardExperimentRequest request)

public ListenableFuture<TensorboardExperiment> getTensorboardExperiment(GetTensorboardExperimentRequest request)

Gets a TensorboardExperiment.

Parameter
NameDescription
requestGetTensorboardExperimentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TensorboardExperiment>

getTensorboardRun(GetTensorboardRunRequest request)

public ListenableFuture<TensorboardRun> getTensorboardRun(GetTensorboardRunRequest request)

Gets a TensorboardRun.

Parameter
NameDescription
requestGetTensorboardRunRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TensorboardRun>

getTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request)

public ListenableFuture<TensorboardTimeSeries> getTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request)

Gets a TensorboardTimeSeries.

Parameter
NameDescription
requestGetTensorboardTimeSeriesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TensorboardTimeSeries>

listTensorboardExperiments(ListTensorboardExperimentsRequest request)

public ListenableFuture<ListTensorboardExperimentsResponse> listTensorboardExperiments(ListTensorboardExperimentsRequest request)

Lists TensorboardExperiments in a Location.

Parameter
NameDescription
requestListTensorboardExperimentsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListTensorboardExperimentsResponse>

listTensorboardRuns(ListTensorboardRunsRequest request)

public ListenableFuture<ListTensorboardRunsResponse> listTensorboardRuns(ListTensorboardRunsRequest request)

Lists TensorboardRuns in a Location.

Parameter
NameDescription
requestListTensorboardRunsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListTensorboardRunsResponse>

listTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request)

public ListenableFuture<ListTensorboardTimeSeriesResponse> listTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request)

Lists TensorboardTimeSeries in a Location.

Parameter
NameDescription
requestListTensorboardTimeSeriesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListTensorboardTimeSeriesResponse>

listTensorboards(ListTensorboardsRequest request)

public ListenableFuture<ListTensorboardsResponse> listTensorboards(ListTensorboardsRequest request)

Lists Tensorboards in a Location.

Parameter
NameDescription
requestListTensorboardsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListTensorboardsResponse>

readTensorboardSize(ReadTensorboardSizeRequest request)

public ListenableFuture<ReadTensorboardSizeResponse> readTensorboardSize(ReadTensorboardSizeRequest request)

Returns the storage size for a given TensorBoard instance.

Parameter
NameDescription
requestReadTensorboardSizeRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ReadTensorboardSizeResponse>

readTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest request)

public ListenableFuture<ReadTensorboardTimeSeriesDataResponse> readTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest request)

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.

Parameter
NameDescription
requestReadTensorboardTimeSeriesDataRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ReadTensorboardTimeSeriesDataResponse>

readTensorboardUsage(ReadTensorboardUsageRequest request)

public ListenableFuture<ReadTensorboardUsageResponse> readTensorboardUsage(ReadTensorboardUsageRequest request)

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

Parameter
NameDescription
requestReadTensorboardUsageRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ReadTensorboardUsageResponse>

updateTensorboard(UpdateTensorboardRequest request)

public ListenableFuture<Operation> updateTensorboard(UpdateTensorboardRequest request)

Updates a Tensorboard.

Parameter
NameDescription
requestUpdateTensorboardRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

updateTensorboardExperiment(UpdateTensorboardExperimentRequest request)

public ListenableFuture<TensorboardExperiment> updateTensorboardExperiment(UpdateTensorboardExperimentRequest request)

Updates a TensorboardExperiment.

Parameter
NameDescription
requestUpdateTensorboardExperimentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TensorboardExperiment>

updateTensorboardRun(UpdateTensorboardRunRequest request)

public ListenableFuture<TensorboardRun> updateTensorboardRun(UpdateTensorboardRunRequest request)

Updates a TensorboardRun.

Parameter
NameDescription
requestUpdateTensorboardRunRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TensorboardRun>

updateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request)

public ListenableFuture<TensorboardTimeSeries> updateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request)

Updates a TensorboardTimeSeries.

Parameter
NameDescription
requestUpdateTensorboardTimeSeriesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TensorboardTimeSeries>

writeTensorboardExperimentData(WriteTensorboardExperimentDataRequest request)

public ListenableFuture<WriteTensorboardExperimentDataResponse> writeTensorboardExperimentData(WriteTensorboardExperimentDataRequest request)

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

Parameter
NameDescription
requestWriteTensorboardExperimentDataRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<WriteTensorboardExperimentDataResponse>

writeTensorboardRunData(WriteTensorboardRunDataRequest request)

public ListenableFuture<WriteTensorboardRunDataResponse> writeTensorboardRunData(WriteTensorboardRunDataRequest request)

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

Parameter
NameDescription
requestWriteTensorboardRunDataRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<WriteTensorboardRunDataResponse>