Class TensorboardServiceGrpc.TensorboardServiceBlockingStub (3.38.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
NameDescription
requestBatchCreateTensorboardRunsRequest
Returns
TypeDescription
BatchCreateTensorboardRunsResponse

batchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request)

public BatchCreateTensorboardTimeSeriesResponse batchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

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

build(Channel channel, CallOptions callOptions)

protected TensorboardServiceGrpc.TensorboardServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
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
NameDescription
requestCreateTensorboardRequest
Returns
TypeDescription
Operation

createTensorboardExperiment(CreateTensorboardExperimentRequest request)

public TensorboardExperiment createTensorboardExperiment(CreateTensorboardExperimentRequest request)

Creates a TensorboardExperiment.

Parameter
NameDescription
requestCreateTensorboardExperimentRequest
Returns
TypeDescription
TensorboardExperiment

createTensorboardRun(CreateTensorboardRunRequest request)

public TensorboardRun createTensorboardRun(CreateTensorboardRunRequest request)

Creates a TensorboardRun.

Parameter
NameDescription
requestCreateTensorboardRunRequest
Returns
TypeDescription
TensorboardRun

createTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request)

public TensorboardTimeSeries createTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request)

Creates a TensorboardTimeSeries.

Parameter
NameDescription
requestCreateTensorboardTimeSeriesRequest
Returns
TypeDescription
TensorboardTimeSeries

deleteTensorboard(DeleteTensorboardRequest request)

public Operation deleteTensorboard(DeleteTensorboardRequest request)

Deletes a Tensorboard.

Parameter
NameDescription
requestDeleteTensorboardRequest
Returns
TypeDescription
Operation

deleteTensorboardExperiment(DeleteTensorboardExperimentRequest request)

public Operation deleteTensorboardExperiment(DeleteTensorboardExperimentRequest request)

Deletes a TensorboardExperiment.

Parameter
NameDescription
requestDeleteTensorboardExperimentRequest
Returns
TypeDescription
Operation

deleteTensorboardRun(DeleteTensorboardRunRequest request)

public Operation deleteTensorboardRun(DeleteTensorboardRunRequest request)

Deletes a TensorboardRun.

Parameter
NameDescription
requestDeleteTensorboardRunRequest
Returns
TypeDescription
Operation

deleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest request)

public Operation deleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest request)

Deletes a TensorboardTimeSeries.

Parameter
NameDescription
requestDeleteTensorboardTimeSeriesRequest
Returns
TypeDescription
Operation

exportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request)

public ExportTensorboardTimeSeriesDataResponse exportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request)

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

Parameter
NameDescription
requestExportTensorboardTimeSeriesDataRequest
Returns
TypeDescription
ExportTensorboardTimeSeriesDataResponse

getTensorboard(GetTensorboardRequest request)

public Tensorboard getTensorboard(GetTensorboardRequest request)

Gets a Tensorboard.

Parameter
NameDescription
requestGetTensorboardRequest
Returns
TypeDescription
Tensorboard

getTensorboardExperiment(GetTensorboardExperimentRequest request)

public TensorboardExperiment getTensorboardExperiment(GetTensorboardExperimentRequest request)

Gets a TensorboardExperiment.

Parameter
NameDescription
requestGetTensorboardExperimentRequest
Returns
TypeDescription
TensorboardExperiment

getTensorboardRun(GetTensorboardRunRequest request)

public TensorboardRun getTensorboardRun(GetTensorboardRunRequest request)

Gets a TensorboardRun.

Parameter
NameDescription
requestGetTensorboardRunRequest
Returns
TypeDescription
TensorboardRun

getTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request)

public TensorboardTimeSeries getTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request)

Gets a TensorboardTimeSeries.

Parameter
NameDescription
requestGetTensorboardTimeSeriesRequest
Returns
TypeDescription
TensorboardTimeSeries

listTensorboardExperiments(ListTensorboardExperimentsRequest request)

public ListTensorboardExperimentsResponse listTensorboardExperiments(ListTensorboardExperimentsRequest request)

Lists TensorboardExperiments in a Location.

Parameter
NameDescription
requestListTensorboardExperimentsRequest
Returns
TypeDescription
ListTensorboardExperimentsResponse

listTensorboardRuns(ListTensorboardRunsRequest request)

public ListTensorboardRunsResponse listTensorboardRuns(ListTensorboardRunsRequest request)

Lists TensorboardRuns in a Location.

Parameter
NameDescription
requestListTensorboardRunsRequest
Returns
TypeDescription
ListTensorboardRunsResponse

listTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request)

public ListTensorboardTimeSeriesResponse listTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request)

Lists TensorboardTimeSeries in a Location.

Parameter
NameDescription
requestListTensorboardTimeSeriesRequest
Returns
TypeDescription
ListTensorboardTimeSeriesResponse

listTensorboards(ListTensorboardsRequest request)

public ListTensorboardsResponse listTensorboards(ListTensorboardsRequest request)

Lists Tensorboards in a Location.

Parameter
NameDescription
requestListTensorboardsRequest
Returns
TypeDescription
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
NameDescription
requestReadTensorboardBlobDataRequest
Returns
TypeDescription
Iterator<ReadTensorboardBlobDataResponse>

readTensorboardSize(ReadTensorboardSizeRequest request)

public ReadTensorboardSizeResponse readTensorboardSize(ReadTensorboardSizeRequest request)

Returns the storage size for a given TensorBoard instance.

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

readTensorboardUsage(ReadTensorboardUsageRequest request)

public ReadTensorboardUsageResponse readTensorboardUsage(ReadTensorboardUsageRequest request)

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

Parameter
NameDescription
requestReadTensorboardUsageRequest
Returns
TypeDescription
ReadTensorboardUsageResponse

updateTensorboard(UpdateTensorboardRequest request)

public Operation updateTensorboard(UpdateTensorboardRequest request)

Updates a Tensorboard.

Parameter
NameDescription
requestUpdateTensorboardRequest
Returns
TypeDescription
Operation

updateTensorboardExperiment(UpdateTensorboardExperimentRequest request)

public TensorboardExperiment updateTensorboardExperiment(UpdateTensorboardExperimentRequest request)

Updates a TensorboardExperiment.

Parameter
NameDescription
requestUpdateTensorboardExperimentRequest
Returns
TypeDescription
TensorboardExperiment

updateTensorboardRun(UpdateTensorboardRunRequest request)

public TensorboardRun updateTensorboardRun(UpdateTensorboardRunRequest request)

Updates a TensorboardRun.

Parameter
NameDescription
requestUpdateTensorboardRunRequest
Returns
TypeDescription
TensorboardRun

updateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request)

public TensorboardTimeSeries updateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request)

Updates a TensorboardTimeSeries.

Parameter
NameDescription
requestUpdateTensorboardTimeSeriesRequest
Returns
TypeDescription
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
NameDescription
requestWriteTensorboardExperimentDataRequest
Returns
TypeDescription
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
NameDescription
requestWriteTensorboardRunDataRequest
Returns
TypeDescription
WriteTensorboardRunDataResponse