Class TensorboardServiceGrpc.TensorboardServiceBlockingStub (3.46.0)

public static final class TensorboardServiceGrpc.TensorboardServiceBlockingStub extends AbstractBlockingStub<TensorboardServiceGrpc.TensorboardServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service TensorboardService.

TensorboardService

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > TensorboardServiceGrpc.TensorboardServiceBlockingStub

Methods

batchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest request)

public BatchCreateTensorboardRunsResponse batchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest request)

Batch create TensorboardRuns.

Parameter
Name Description
request BatchCreateTensorboardRunsRequest
Returns
Type Description
BatchCreateTensorboardRunsResponse

batchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request)

public BatchCreateTensorboardTimeSeriesResponse batchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameter
Name Description
request BatchCreateTensorboardTimeSeriesRequest
Returns
Type Description
BatchCreateTensorboardTimeSeriesResponse

batchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest request)

public 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
Name Description
request BatchReadTensorboardTimeSeriesDataRequest
Returns
Type Description
BatchReadTensorboardTimeSeriesDataResponse

build(Channel channel, CallOptions callOptions)

protected TensorboardServiceGrpc.TensorboardServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
TensorboardServiceGrpc.TensorboardServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createTensorboard(CreateTensorboardRequest request)

public Operation createTensorboard(CreateTensorboardRequest request)

Creates a Tensorboard.

Parameter
Name Description
request CreateTensorboardRequest
Returns
Type Description
Operation

createTensorboardExperiment(CreateTensorboardExperimentRequest request)

public TensorboardExperiment createTensorboardExperiment(CreateTensorboardExperimentRequest request)

Creates a TensorboardExperiment.

Parameter
Name Description
request CreateTensorboardExperimentRequest
Returns
Type Description
TensorboardExperiment

createTensorboardRun(CreateTensorboardRunRequest request)

public TensorboardRun createTensorboardRun(CreateTensorboardRunRequest request)

Creates a TensorboardRun.

Parameter
Name Description
request CreateTensorboardRunRequest
Returns
Type Description
TensorboardRun

createTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request)

public TensorboardTimeSeries createTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request)

Creates a TensorboardTimeSeries.

Parameter
Name Description
request CreateTensorboardTimeSeriesRequest
Returns
Type Description
TensorboardTimeSeries

deleteTensorboard(DeleteTensorboardRequest request)

public Operation deleteTensorboard(DeleteTensorboardRequest request)

Deletes a Tensorboard.

Parameter
Name Description
request DeleteTensorboardRequest
Returns
Type Description
Operation

deleteTensorboardExperiment(DeleteTensorboardExperimentRequest request)

public Operation deleteTensorboardExperiment(DeleteTensorboardExperimentRequest request)

Deletes a TensorboardExperiment.

Parameter
Name Description
request DeleteTensorboardExperimentRequest
Returns
Type Description
Operation

deleteTensorboardRun(DeleteTensorboardRunRequest request)

public Operation deleteTensorboardRun(DeleteTensorboardRunRequest request)

Deletes a TensorboardRun.

Parameter
Name Description
request DeleteTensorboardRunRequest
Returns
Type Description
Operation

deleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest request)

public Operation deleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest request)

Deletes a TensorboardTimeSeries.

Parameter
Name Description
request DeleteTensorboardTimeSeriesRequest
Returns
Type Description
Operation

exportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request)

public ExportTensorboardTimeSeriesDataResponse exportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request)

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

Parameter
Name Description
request ExportTensorboardTimeSeriesDataRequest
Returns
Type Description
ExportTensorboardTimeSeriesDataResponse

getTensorboard(GetTensorboardRequest request)

public Tensorboard getTensorboard(GetTensorboardRequest request)

Gets a Tensorboard.

Parameter
Name Description
request GetTensorboardRequest
Returns
Type Description
Tensorboard

getTensorboardExperiment(GetTensorboardExperimentRequest request)

public TensorboardExperiment getTensorboardExperiment(GetTensorboardExperimentRequest request)

Gets a TensorboardExperiment.

Parameter
Name Description
request GetTensorboardExperimentRequest
Returns
Type Description
TensorboardExperiment

getTensorboardRun(GetTensorboardRunRequest request)

public TensorboardRun getTensorboardRun(GetTensorboardRunRequest request)

Gets a TensorboardRun.

Parameter
Name Description
request GetTensorboardRunRequest
Returns
Type Description
TensorboardRun

getTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request)

public TensorboardTimeSeries getTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request)

Gets a TensorboardTimeSeries.

Parameter
Name Description
request GetTensorboardTimeSeriesRequest
Returns
Type Description
TensorboardTimeSeries

listTensorboardExperiments(ListTensorboardExperimentsRequest request)

public ListTensorboardExperimentsResponse listTensorboardExperiments(ListTensorboardExperimentsRequest request)

Lists TensorboardExperiments in a Location.

Parameter
Name Description
request ListTensorboardExperimentsRequest
Returns
Type Description
ListTensorboardExperimentsResponse

listTensorboardRuns(ListTensorboardRunsRequest request)

public ListTensorboardRunsResponse listTensorboardRuns(ListTensorboardRunsRequest request)

Lists TensorboardRuns in a Location.

Parameter
Name Description
request ListTensorboardRunsRequest
Returns
Type Description
ListTensorboardRunsResponse

listTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request)

public ListTensorboardTimeSeriesResponse listTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request)

Lists TensorboardTimeSeries in a Location.

Parameter
Name Description
request ListTensorboardTimeSeriesRequest
Returns
Type Description
ListTensorboardTimeSeriesResponse

listTensorboards(ListTensorboardsRequest request)

public ListTensorboardsResponse listTensorboards(ListTensorboardsRequest request)

Lists Tensorboards in a Location.

Parameter
Name Description
request ListTensorboardsRequest
Returns
Type Description
ListTensorboardsResponse

readTensorboardBlobData(ReadTensorboardBlobDataRequest request)

public Iterator<ReadTensorboardBlobDataResponse> readTensorboardBlobData(ReadTensorboardBlobDataRequest request)

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.

Parameter
Name Description
request ReadTensorboardBlobDataRequest
Returns
Type Description
Iterator<ReadTensorboardBlobDataResponse>

readTensorboardSize(ReadTensorboardSizeRequest request)

public ReadTensorboardSizeResponse readTensorboardSize(ReadTensorboardSizeRequest request)

Returns the storage size for a given TensorBoard instance.

Parameter
Name Description
request ReadTensorboardSizeRequest
Returns
Type Description
ReadTensorboardSizeResponse

readTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest request)

public 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
Name Description
request ReadTensorboardTimeSeriesDataRequest
Returns
Type Description
ReadTensorboardTimeSeriesDataResponse

readTensorboardUsage(ReadTensorboardUsageRequest request)

public ReadTensorboardUsageResponse readTensorboardUsage(ReadTensorboardUsageRequest request)

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

Parameter
Name Description
request ReadTensorboardUsageRequest
Returns
Type Description
ReadTensorboardUsageResponse

updateTensorboard(UpdateTensorboardRequest request)

public Operation updateTensorboard(UpdateTensorboardRequest request)

Updates a Tensorboard.

Parameter
Name Description
request UpdateTensorboardRequest
Returns
Type Description
Operation

updateTensorboardExperiment(UpdateTensorboardExperimentRequest request)

public TensorboardExperiment updateTensorboardExperiment(UpdateTensorboardExperimentRequest request)

Updates a TensorboardExperiment.

Parameter
Name Description
request UpdateTensorboardExperimentRequest
Returns
Type Description
TensorboardExperiment

updateTensorboardRun(UpdateTensorboardRunRequest request)

public TensorboardRun updateTensorboardRun(UpdateTensorboardRunRequest request)

Updates a TensorboardRun.

Parameter
Name Description
request UpdateTensorboardRunRequest
Returns
Type Description
TensorboardRun

updateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request)

public TensorboardTimeSeries updateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request)

Updates a TensorboardTimeSeries.

Parameter
Name Description
request UpdateTensorboardTimeSeriesRequest
Returns
Type Description
TensorboardTimeSeries

writeTensorboardExperimentData(WriteTensorboardExperimentDataRequest request)

public 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
Name Description
request WriteTensorboardExperimentDataRequest
Returns
Type Description
WriteTensorboardExperimentDataResponse

writeTensorboardRunData(WriteTensorboardRunDataRequest request)

public 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
Name Description
request WriteTensorboardRunDataRequest
Returns
Type Description
WriteTensorboardRunDataResponse