Class TensorboardServiceClient (2.4.0)

Version 2.4.0

• 3.56.0 (latest)
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public class TensorboardServiceClient implements BackgroundResource

Service Description: TensorboardService

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardName name = TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
   Tensorboard response = tensorboardServiceClient.getTensorboard(name);
 }
 

Note: close() needs to be called on the TensorboardServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of TensorboardServiceSettings to create(). For example:

To customize credentials:

 TensorboardServiceSettings tensorboardServiceSettings =
     TensorboardServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TensorboardServiceClient tensorboardServiceClient =
     TensorboardServiceClient.create(tensorboardServiceSettings);
 

To customize the endpoint:

 TensorboardServiceSettings tensorboardServiceSettings =
     TensorboardServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TensorboardServiceClient tensorboardServiceClient =
     TensorboardServiceClient.create(tensorboardServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > TensorboardServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

TensorboardServiceClient(TensorboardServiceSettings settings)

protected TensorboardServiceClient(TensorboardServiceSettings settings)

Constructs an instance of TensorboardServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter

Name	Description
settings	TensorboardServiceSettings

TensorboardServiceClient(TensorboardServiceStub stub)

protected TensorboardServiceClient(TensorboardServiceStub stub)

Parameter

Name	Description
stub	TensorboardServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

batchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest request)

public final BatchCreateTensorboardRunsResponse batchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest request)

Batch create TensorboardRuns.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   BatchCreateTensorboardRunsRequest request =
       BatchCreateTensorboardRunsRequest.newBuilder()
           .setParent(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .addAllRequests(new ArrayList

Parameter

Name	Description
request	BatchCreateTensorboardRunsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
BatchCreateTensorboardRunsResponse

batchCreateTensorboardRuns(TensorboardExperimentName parent, List<CreateTensorboardRunRequest> requests)

public final BatchCreateTensorboardRunsResponse batchCreateTensorboardRuns(TensorboardExperimentName parent, List<CreateTensorboardRunRequest> requests)

Batch create TensorboardRuns.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardExperimentName parent =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
   List

Parameters

Name	Description
parent	TensorboardExperimentName Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} The parent field in the CreateTensorboardRunRequest messages must match this field.
requests	List<CreateTensorboardRunRequest> Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.

Returns

Type	Description
BatchCreateTensorboardRunsResponse

batchCreateTensorboardRuns(String parent, List<CreateTensorboardRunRequest> requests)

public final BatchCreateTensorboardRunsResponse batchCreateTensorboardRuns(String parent, List<CreateTensorboardRunRequest> requests)

Batch create TensorboardRuns.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String parent =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
           .toString();
   List

Parameters

Name	Description
parent	String Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} The parent field in the CreateTensorboardRunRequest messages must match this field.
requests	List<CreateTensorboardRunRequest> Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.

Returns

Type	Description
BatchCreateTensorboardRunsResponse

batchCreateTensorboardRunsCallable()

public final UnaryCallable<BatchCreateTensorboardRunsRequest,BatchCreateTensorboardRunsResponse> batchCreateTensorboardRunsCallable()

Batch create TensorboardRuns.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   BatchCreateTensorboardRunsRequest request =
       BatchCreateTensorboardRunsRequest.newBuilder()
           .setParent(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .addAllRequests(new ArrayList

Returns

Type	Description
UnaryCallable<BatchCreateTensorboardRunsRequest,BatchCreateTensorboardRunsResponse>

batchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request)

public final BatchCreateTensorboardTimeSeriesResponse batchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   BatchCreateTensorboardTimeSeriesRequest request =
       BatchCreateTensorboardTimeSeriesRequest.newBuilder()
           .setParent(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .addAllRequests(new ArrayList

Parameter

Name	Description
request	BatchCreateTensorboardTimeSeriesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
BatchCreateTensorboardTimeSeriesResponse

batchCreateTensorboardTimeSeries(TensorboardExperimentName parent, List<CreateTensorboardTimeSeriesRequest> requests)

public final BatchCreateTensorboardTimeSeriesResponse batchCreateTensorboardTimeSeries(TensorboardExperimentName parent, List<CreateTensorboardTimeSeriesRequest> requests)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardExperimentName parent =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
   List

Parameters

Name	Description
parent	TensorboardExperimentName Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.
requests	List<CreateTensorboardTimeSeriesRequest> Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.

Returns

Type	Description
BatchCreateTensorboardTimeSeriesResponse

batchCreateTensorboardTimeSeries(String parent, List<CreateTensorboardTimeSeriesRequest> requests)

public final BatchCreateTensorboardTimeSeriesResponse batchCreateTensorboardTimeSeries(String parent, List<CreateTensorboardTimeSeriesRequest> requests)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String parent =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
           .toString();
   List

Parameters

Name	Description
parent	String Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.
requests	List<CreateTensorboardTimeSeriesRequest> Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.

Returns

Type	Description
BatchCreateTensorboardTimeSeriesResponse

batchCreateTensorboardTimeSeriesCallable()

public final UnaryCallable<BatchCreateTensorboardTimeSeriesRequest,BatchCreateTensorboardTimeSeriesResponse> batchCreateTensorboardTimeSeriesCallable()

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   BatchCreateTensorboardTimeSeriesRequest request =
       BatchCreateTensorboardTimeSeriesRequest.newBuilder()
           .setParent(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .addAllRequests(new ArrayList

Returns

Type	Description
UnaryCallable<BatchCreateTensorboardTimeSeriesRequest,BatchCreateTensorboardTimeSeriesResponse>

batchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest request)

public final 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 will be returned. Otherwise, that limit number of data points will be randomly selected from this time series and returned.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   BatchReadTensorboardTimeSeriesDataRequest request =
       BatchReadTensorboardTimeSeriesDataRequest.newBuilder()
           .setTensorboard(
               TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString())
           .addAllTimeSeries(new ArrayList

Parameter

Name	Description
request	BatchReadTensorboardTimeSeriesDataRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
BatchReadTensorboardTimeSeriesDataResponse

batchReadTensorboardTimeSeriesData(TensorboardName tensorboard)

public final BatchReadTensorboardTimeSeriesDataResponse batchReadTensorboardTimeSeriesData(TensorboardName tensorboard)

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 will be returned. Otherwise, that limit number of data points will be randomly selected from this time series and returned.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardName tensorboard = TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
   BatchReadTensorboardTimeSeriesDataResponse response =
       tensorboardServiceClient.batchReadTensorboardTimeSeriesData(tensorboard);
 }
 

Parameter

Name	Description
tensorboard	TensorboardName Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.

Returns

Type	Description
BatchReadTensorboardTimeSeriesDataResponse

batchReadTensorboardTimeSeriesData(String tensorboard)

public final BatchReadTensorboardTimeSeriesDataResponse batchReadTensorboardTimeSeriesData(String tensorboard)

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 will be returned. Otherwise, that limit number of data points will be randomly selected from this time series and returned.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String tensorboard =
       TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString();
   BatchReadTensorboardTimeSeriesDataResponse response =
       tensorboardServiceClient.batchReadTensorboardTimeSeriesData(tensorboard);
 }
 

Parameter

Name	Description
tensorboard	String Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.

Returns

Type	Description
BatchReadTensorboardTimeSeriesDataResponse

batchReadTensorboardTimeSeriesDataCallable()

public final UnaryCallable<BatchReadTensorboardTimeSeriesDataRequest,BatchReadTensorboardTimeSeriesDataResponse> batchReadTensorboardTimeSeriesDataCallable()

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 will be returned. Otherwise, that limit number of data points will be randomly selected from this time series and returned.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   BatchReadTensorboardTimeSeriesDataRequest request =
       BatchReadTensorboardTimeSeriesDataRequest.newBuilder()
           .setTensorboard(
               TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString())
           .addAllTimeSeries(new ArrayList

Returns

Type	Description
UnaryCallable<BatchReadTensorboardTimeSeriesDataRequest,BatchReadTensorboardTimeSeriesDataResponse>

close()

public final void close()

create()

public static final TensorboardServiceClient create()

Constructs an instance of TensorboardServiceClient with default settings.

Returns

Type	Description
TensorboardServiceClient

Exceptions

Type	Description
IOException

create(TensorboardServiceSettings settings)

public static final TensorboardServiceClient create(TensorboardServiceSettings settings)

Constructs an instance of TensorboardServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter

Name	Description
settings	TensorboardServiceSettings

Returns

Type	Description
TensorboardServiceClient

Exceptions

Type	Description
IOException

create(TensorboardServiceStub stub)

public static final TensorboardServiceClient create(TensorboardServiceStub stub)

Constructs an instance of TensorboardServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(TensorboardServiceSettings).

Parameter

Name	Description
stub	TensorboardServiceStub

Returns

Type	Description
TensorboardServiceClient

createTensorboardAsync(CreateTensorboardRequest request)

public final OperationFuture<Tensorboard,CreateTensorboardOperationMetadata> createTensorboardAsync(CreateTensorboardRequest request)

Creates a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   CreateTensorboardRequest request =
       CreateTensorboardRequest.newBuilder()
           .setParent(TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString())
           .setTensorboard(Tensorboard.newBuilder().build())
           .build();
   Tensorboard response = tensorboardServiceClient.createTensorboardAsync(request).get();
 }
 

Parameter

Name	Description
request	CreateTensorboardRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Tensorboard,CreateTensorboardOperationMetadata>

createTensorboardAsync(TensorboardName parent, Tensorboard tensorboard)

public final OperationFuture<Tensorboard,CreateTensorboardOperationMetadata> createTensorboardAsync(TensorboardName parent, Tensorboard tensorboard)

Creates a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardName parent = TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
   Tensorboard tensorboard = Tensorboard.newBuilder().build();
   Tensorboard response =
       tensorboardServiceClient.createTensorboardAsync(parent, tensorboard).get();
 }
 

Parameters

Name	Description
parent	TensorboardName Required. The resource name of the Location to create the Tensorboard in. Format: projects/{project}/locations/{location}
tensorboard	Tensorboard Required. The Tensorboard to create.

Returns

Type	Description
OperationFuture<Tensorboard,CreateTensorboardOperationMetadata>

createTensorboardAsync(String parent, Tensorboard tensorboard)

public final OperationFuture<Tensorboard,CreateTensorboardOperationMetadata> createTensorboardAsync(String parent, Tensorboard tensorboard)

Creates a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String parent = TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString();
   Tensorboard tensorboard = Tensorboard.newBuilder().build();
   Tensorboard response =
       tensorboardServiceClient.createTensorboardAsync(parent, tensorboard).get();
 }
 

Parameters

Name	Description
parent	String Required. The resource name of the Location to create the Tensorboard in. Format: projects/{project}/locations/{location}
tensorboard	Tensorboard Required. The Tensorboard to create.

Returns

Type	Description
OperationFuture<Tensorboard,CreateTensorboardOperationMetadata>

createTensorboardCallable()

public final UnaryCallable<CreateTensorboardRequest,Operation> createTensorboardCallable()

Creates a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   CreateTensorboardRequest request =
       CreateTensorboardRequest.newBuilder()
           .setParent(TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString())
           .setTensorboard(Tensorboard.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateTensorboardRequest,Operation>

createTensorboardExperiment(CreateTensorboardExperimentRequest request)

public final TensorboardExperiment createTensorboardExperiment(CreateTensorboardExperimentRequest request)

Creates a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   CreateTensorboardExperimentRequest request =
       CreateTensorboardExperimentRequest.newBuilder()
           .setParent(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .setTensorboardExperiment(TensorboardExperiment.newBuilder().build())
           .setTensorboardExperimentId("tensorboardExperimentId1267328197")
           .build();
   TensorboardExperiment response =
       tensorboardServiceClient.createTensorboardExperiment(request);
 }
 

Parameter

Name	Description
request	CreateTensorboardExperimentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardExperiment

createTensorboardExperiment(TensorboardExperimentName parent, TensorboardExperiment tensorboardExperiment, String tensorboardExperimentId)

public final TensorboardExperiment createTensorboardExperiment(TensorboardExperimentName parent, TensorboardExperiment tensorboardExperiment, String tensorboardExperimentId)

Creates a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardExperimentName parent =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
   TensorboardExperiment tensorboardExperiment = TensorboardExperiment.newBuilder().build();
   String tensorboardExperimentId = "tensorboardExperimentId1267328197";
   TensorboardExperiment response =
       tensorboardServiceClient.createTensorboardExperiment(
           parent, tensorboardExperiment, tensorboardExperimentId);
 }
 

Parameters

Name	Description
parent	TensorboardExperimentName Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
tensorboardExperiment	TensorboardExperiment The TensorboardExperiment to create.
tensorboardExperimentId	String Required. The ID to use for the Tensorboard experiment, which will become the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.

Returns

Type	Description
TensorboardExperiment

createTensorboardExperiment(String parent, TensorboardExperiment tensorboardExperiment, String tensorboardExperimentId)

public final TensorboardExperiment createTensorboardExperiment(String parent, TensorboardExperiment tensorboardExperiment, String tensorboardExperimentId)

Creates a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String parent =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
           .toString();
   TensorboardExperiment tensorboardExperiment = TensorboardExperiment.newBuilder().build();
   String tensorboardExperimentId = "tensorboardExperimentId1267328197";
   TensorboardExperiment response =
       tensorboardServiceClient.createTensorboardExperiment(
           parent, tensorboardExperiment, tensorboardExperimentId);
 }
 

Parameters

Name	Description
parent	String Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
tensorboardExperiment	TensorboardExperiment The TensorboardExperiment to create.
tensorboardExperimentId	String Required. The ID to use for the Tensorboard experiment, which will become the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.

Returns

Type	Description
TensorboardExperiment

createTensorboardExperimentCallable()

public final UnaryCallable<CreateTensorboardExperimentRequest,TensorboardExperiment> createTensorboardExperimentCallable()

Creates a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   CreateTensorboardExperimentRequest request =
       CreateTensorboardExperimentRequest.newBuilder()
           .setParent(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .setTensorboardExperiment(TensorboardExperiment.newBuilder().build())
           .setTensorboardExperimentId("tensorboardExperimentId1267328197")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateTensorboardExperimentRequest,TensorboardExperiment>

createTensorboardOperationCallable()

public final OperationCallable<CreateTensorboardRequest,Tensorboard,CreateTensorboardOperationMetadata> createTensorboardOperationCallable()

Creates a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   CreateTensorboardRequest request =
       CreateTensorboardRequest.newBuilder()
           .setParent(TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString())
           .setTensorboard(Tensorboard.newBuilder().build())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<CreateTensorboardRequest,Tensorboard,CreateTensorboardOperationMetadata>

createTensorboardRun(CreateTensorboardRunRequest request)

public final TensorboardRun createTensorboardRun(CreateTensorboardRunRequest request)

Creates a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   CreateTensorboardRunRequest request =
       CreateTensorboardRunRequest.newBuilder()
           .setParent(
               TensorboardRunName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
                   .toString())
           .setTensorboardRun(TensorboardRun.newBuilder().build())
           .setTensorboardRunId("tensorboardRunId-407822631")
           .build();
   TensorboardRun response = tensorboardServiceClient.createTensorboardRun(request);
 }
 

Parameter

Name	Description
request	CreateTensorboardRunRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardRun

createTensorboardRun(TensorboardRunName parent, TensorboardRun tensorboardRun, String tensorboardRunId)

public final TensorboardRun createTensorboardRun(TensorboardRunName parent, TensorboardRun tensorboardRun, String tensorboardRunId)

Creates a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardRunName parent =
       TensorboardRunName.of(
           "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
   TensorboardRun tensorboardRun = TensorboardRun.newBuilder().build();
   String tensorboardRunId = "tensorboardRunId-407822631";
   TensorboardRun response =
       tensorboardServiceClient.createTensorboardRun(parent, tensorboardRun, tensorboardRunId);
 }
 

Parameters

Name	Description
parent	TensorboardRunName Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
tensorboardRun	TensorboardRun Required. The TensorboardRun to create.
tensorboardRunId	String Required. The ID to use for the Tensorboard run, which will become the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.

Returns

Type	Description
TensorboardRun

createTensorboardRun(String parent, TensorboardRun tensorboardRun, String tensorboardRunId)

public final TensorboardRun createTensorboardRun(String parent, TensorboardRun tensorboardRun, String tensorboardRunId)

Creates a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String parent =
       TensorboardRunName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
           .toString();
   TensorboardRun tensorboardRun = TensorboardRun.newBuilder().build();
   String tensorboardRunId = "tensorboardRunId-407822631";
   TensorboardRun response =
       tensorboardServiceClient.createTensorboardRun(parent, tensorboardRun, tensorboardRunId);
 }
 

Parameters

Name	Description
parent	String Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
tensorboardRun	TensorboardRun Required. The TensorboardRun to create.
tensorboardRunId	String Required. The ID to use for the Tensorboard run, which will become the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.

Returns

Type	Description
TensorboardRun

createTensorboardRunCallable()

public final UnaryCallable<CreateTensorboardRunRequest,TensorboardRun> createTensorboardRunCallable()

Creates a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   CreateTensorboardRunRequest request =
       CreateTensorboardRunRequest.newBuilder()
           .setParent(
               TensorboardRunName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
                   .toString())
           .setTensorboardRun(TensorboardRun.newBuilder().build())
           .setTensorboardRunId("tensorboardRunId-407822631")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateTensorboardRunRequest,TensorboardRun>

createTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request)

public final TensorboardTimeSeries createTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request)

Creates a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   CreateTensorboardTimeSeriesRequest request =
       CreateTensorboardTimeSeriesRequest.newBuilder()
           .setParent(
               TensorboardTimeSeriesName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[TENSORBOARD]",
                       "[EXPERIMENT]",
                       "[RUN]",
                       "[TIME_SERIES]")
                   .toString())
           .setTensorboardTimeSeriesId("tensorboardTimeSeriesId-913380692")
           .setTensorboardTimeSeries(TensorboardTimeSeries.newBuilder().build())
           .build();
   TensorboardTimeSeries response =
       tensorboardServiceClient.createTensorboardTimeSeries(request);
 }
 

Parameter

Name	Description
request	CreateTensorboardTimeSeriesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardTimeSeries

createTensorboardTimeSeries(TensorboardTimeSeriesName parent, TensorboardTimeSeries tensorboardTimeSeries)

public final TensorboardTimeSeries createTensorboardTimeSeries(TensorboardTimeSeriesName parent, TensorboardTimeSeries tensorboardTimeSeries)

Creates a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardTimeSeriesName parent =
       TensorboardTimeSeriesName.of(
           "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
   TensorboardTimeSeries tensorboardTimeSeries = TensorboardTimeSeries.newBuilder().build();
   TensorboardTimeSeries response =
       tensorboardServiceClient.createTensorboardTimeSeries(parent, tensorboardTimeSeries);
 }
 

Parameters

Name	Description
parent	TensorboardTimeSeriesName Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
tensorboardTimeSeries	TensorboardTimeSeries Required. The TensorboardTimeSeries to create.

Returns

Type	Description
TensorboardTimeSeries

createTensorboardTimeSeries(String parent, TensorboardTimeSeries tensorboardTimeSeries)

public final TensorboardTimeSeries createTensorboardTimeSeries(String parent, TensorboardTimeSeries tensorboardTimeSeries)

Creates a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String parent =
       TensorboardTimeSeriesName.of(
               "[PROJECT]",
               "[LOCATION]",
               "[TENSORBOARD]",
               "[EXPERIMENT]",
               "[RUN]",
               "[TIME_SERIES]")
           .toString();
   TensorboardTimeSeries tensorboardTimeSeries = TensorboardTimeSeries.newBuilder().build();
   TensorboardTimeSeries response =
       tensorboardServiceClient.createTensorboardTimeSeries(parent, tensorboardTimeSeries);
 }
 

Parameters

Name	Description
parent	String Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
tensorboardTimeSeries	TensorboardTimeSeries Required. The TensorboardTimeSeries to create.

Returns

Type	Description
TensorboardTimeSeries

createTensorboardTimeSeriesCallable()

public final UnaryCallable<CreateTensorboardTimeSeriesRequest,TensorboardTimeSeries> createTensorboardTimeSeriesCallable()

Creates a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   CreateTensorboardTimeSeriesRequest request =
       CreateTensorboardTimeSeriesRequest.newBuilder()
           .setParent(
               TensorboardTimeSeriesName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[TENSORBOARD]",
                       "[EXPERIMENT]",
                       "[RUN]",
                       "[TIME_SERIES]")
                   .toString())
           .setTensorboardTimeSeriesId("tensorboardTimeSeriesId-913380692")
           .setTensorboardTimeSeries(TensorboardTimeSeries.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateTensorboardTimeSeriesRequest,TensorboardTimeSeries>

deleteTensorboardAsync(DeleteTensorboardRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteTensorboardAsync(DeleteTensorboardRequest request)

Deletes a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   DeleteTensorboardRequest request =
       DeleteTensorboardRequest.newBuilder()
           .setName(TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString())
           .build();
   tensorboardServiceClient.deleteTensorboardAsync(request).get();
 }
 

Parameter

Name	Description
request	DeleteTensorboardRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTensorboardAsync(TensorboardName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteTensorboardAsync(TensorboardName name)

Deletes a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardName name = TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
   tensorboardServiceClient.deleteTensorboardAsync(name).get();
 }
 

Parameter

Name	Description
name	TensorboardName Required. The name of the Tensorboard to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTensorboardAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteTensorboardAsync(String name)

Deletes a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String name = TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString();
   tensorboardServiceClient.deleteTensorboardAsync(name).get();
 }
 

Parameter

Name	Description
name	String Required. The name of the Tensorboard to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTensorboardCallable()

public final UnaryCallable<DeleteTensorboardRequest,Operation> deleteTensorboardCallable()

Deletes a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   DeleteTensorboardRequest request =
       DeleteTensorboardRequest.newBuilder()
           .setName(TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<DeleteTensorboardRequest,Operation>

deleteTensorboardExperimentAsync(DeleteTensorboardExperimentRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteTensorboardExperimentAsync(DeleteTensorboardExperimentRequest request)

Deletes a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   DeleteTensorboardExperimentRequest request =
       DeleteTensorboardExperimentRequest.newBuilder()
           .setName(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .build();
   tensorboardServiceClient.deleteTensorboardExperimentAsync(request).get();
 }
 

Parameter

Name	Description
request	DeleteTensorboardExperimentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTensorboardExperimentAsync(TensorboardExperimentName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteTensorboardExperimentAsync(TensorboardExperimentName name)

Deletes a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardExperimentName name =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
   tensorboardServiceClient.deleteTensorboardExperimentAsync(name).get();
 }
 

Parameter

Name	Description
name	TensorboardExperimentName Required. The name of the TensorboardExperiment to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTensorboardExperimentAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteTensorboardExperimentAsync(String name)

Deletes a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String name =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
           .toString();
   tensorboardServiceClient.deleteTensorboardExperimentAsync(name).get();
 }
 

Parameter

Name	Description
name	String Required. The name of the TensorboardExperiment to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTensorboardExperimentCallable()

public final UnaryCallable<DeleteTensorboardExperimentRequest,Operation> deleteTensorboardExperimentCallable()

Deletes a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   DeleteTensorboardExperimentRequest request =
       DeleteTensorboardExperimentRequest.newBuilder()
           .setName(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<DeleteTensorboardExperimentRequest,Operation>

deleteTensorboardExperimentOperationCallable()

public final OperationCallable<DeleteTensorboardExperimentRequest,Empty,DeleteOperationMetadata> deleteTensorboardExperimentOperationCallable()

Deletes a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   DeleteTensorboardExperimentRequest request =
       DeleteTensorboardExperimentRequest.newBuilder()
           .setName(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeleteTensorboardExperimentRequest,Empty,DeleteOperationMetadata>

deleteTensorboardOperationCallable()

public final OperationCallable<DeleteTensorboardRequest,Empty,DeleteOperationMetadata> deleteTensorboardOperationCallable()

Deletes a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   DeleteTensorboardRequest request =
       DeleteTensorboardRequest.newBuilder()
           .setName(TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeleteTensorboardRequest,Empty,DeleteOperationMetadata>

deleteTensorboardRunAsync(DeleteTensorboardRunRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteTensorboardRunAsync(DeleteTensorboardRunRequest request)

Deletes a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   DeleteTensorboardRunRequest request =
       DeleteTensorboardRunRequest.newBuilder()
           .setName(
               TensorboardRunName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
                   .toString())
           .build();
   tensorboardServiceClient.deleteTensorboardRunAsync(request).get();
 }
 

Parameter

Name	Description
request	DeleteTensorboardRunRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTensorboardRunAsync(TensorboardRunName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteTensorboardRunAsync(TensorboardRunName name)

Deletes a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardRunName name =
       TensorboardRunName.of(
           "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
   tensorboardServiceClient.deleteTensorboardRunAsync(name).get();
 }
 

Parameter

Name	Description
name	TensorboardRunName Required. The name of the TensorboardRun to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTensorboardRunAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteTensorboardRunAsync(String name)

Deletes a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String name =
       TensorboardRunName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
           .toString();
   tensorboardServiceClient.deleteTensorboardRunAsync(name).get();
 }
 

Parameter

Name	Description
name	String Required. The name of the TensorboardRun to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTensorboardRunCallable()

public final UnaryCallable<DeleteTensorboardRunRequest,Operation> deleteTensorboardRunCallable()

Deletes a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   DeleteTensorboardRunRequest request =
       DeleteTensorboardRunRequest.newBuilder()
           .setName(
               TensorboardRunName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
                   .toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<DeleteTensorboardRunRequest,Operation>

deleteTensorboardRunOperationCallable()

public final OperationCallable<DeleteTensorboardRunRequest,Empty,DeleteOperationMetadata> deleteTensorboardRunOperationCallable()

Deletes a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   DeleteTensorboardRunRequest request =
       DeleteTensorboardRunRequest.newBuilder()
           .setName(
               TensorboardRunName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
                   .toString())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeleteTensorboardRunRequest,Empty,DeleteOperationMetadata>

deleteTensorboardTimeSeriesAsync(DeleteTensorboardTimeSeriesRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteTensorboardTimeSeriesAsync(DeleteTensorboardTimeSeriesRequest request)

Deletes a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   DeleteTensorboardTimeSeriesRequest request =
       DeleteTensorboardTimeSeriesRequest.newBuilder()
           .setName(
               TensorboardTimeSeriesName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[TENSORBOARD]",
                       "[EXPERIMENT]",
                       "[RUN]",
                       "[TIME_SERIES]")
                   .toString())
           .build();
   tensorboardServiceClient.deleteTensorboardTimeSeriesAsync(request).get();
 }
 

Parameter

Name	Description
request	DeleteTensorboardTimeSeriesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTensorboardTimeSeriesAsync(TensorboardTimeSeriesName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteTensorboardTimeSeriesAsync(TensorboardTimeSeriesName name)

Deletes a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardTimeSeriesName name =
       TensorboardTimeSeriesName.of(
           "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
   tensorboardServiceClient.deleteTensorboardTimeSeriesAsync(name).get();
 }
 

Parameter

Name	Description
name	TensorboardTimeSeriesName Required. The name of the TensorboardTimeSeries to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTensorboardTimeSeriesAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteTensorboardTimeSeriesAsync(String name)

Deletes a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String name =
       TensorboardTimeSeriesName.of(
               "[PROJECT]",
               "[LOCATION]",
               "[TENSORBOARD]",
               "[EXPERIMENT]",
               "[RUN]",
               "[TIME_SERIES]")
           .toString();
   tensorboardServiceClient.deleteTensorboardTimeSeriesAsync(name).get();
 }
 

Parameter

Name	Description
name	String Required. The name of the TensorboardTimeSeries to be deleted. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteTensorboardTimeSeriesCallable()

public final UnaryCallable<DeleteTensorboardTimeSeriesRequest,Operation> deleteTensorboardTimeSeriesCallable()

Deletes a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   DeleteTensorboardTimeSeriesRequest request =
       DeleteTensorboardTimeSeriesRequest.newBuilder()
           .setName(
               TensorboardTimeSeriesName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[TENSORBOARD]",
                       "[EXPERIMENT]",
                       "[RUN]",
                       "[TIME_SERIES]")
                   .toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<DeleteTensorboardTimeSeriesRequest,Operation>

deleteTensorboardTimeSeriesOperationCallable()

public final OperationCallable<DeleteTensorboardTimeSeriesRequest,Empty,DeleteOperationMetadata> deleteTensorboardTimeSeriesOperationCallable()

Deletes a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   DeleteTensorboardTimeSeriesRequest request =
       DeleteTensorboardTimeSeriesRequest.newBuilder()
           .setName(
               TensorboardTimeSeriesName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[TENSORBOARD]",
                       "[EXPERIMENT]",
                       "[RUN]",
                       "[TIME_SERIES]")
                   .toString())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeleteTensorboardTimeSeriesRequest,Empty,DeleteOperationMetadata>

exportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request)

public final TensorboardServiceClient.ExportTensorboardTimeSeriesDataPagedResponse exportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request)

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

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ExportTensorboardTimeSeriesDataRequest request =
       ExportTensorboardTimeSeriesDataRequest.newBuilder()
           .setTensorboardTimeSeries(
               TensorboardTimeSeriesName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[TENSORBOARD]",
                       "[EXPERIMENT]",
                       "[RUN]",
                       "[TIME_SERIES]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (TimeSeriesDataPoint element :
       tensorboardServiceClient.exportTensorboardTimeSeriesData(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ExportTensorboardTimeSeriesDataRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardServiceClient.ExportTensorboardTimeSeriesDataPagedResponse

exportTensorboardTimeSeriesData(TensorboardTimeSeriesName tensorboardTimeSeries)

public final TensorboardServiceClient.ExportTensorboardTimeSeriesDataPagedResponse exportTensorboardTimeSeriesData(TensorboardTimeSeriesName tensorboardTimeSeries)

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

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardTimeSeriesName tensorboardTimeSeries =
       TensorboardTimeSeriesName.of(
           "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
   for (TimeSeriesDataPoint element :
       tensorboardServiceClient
           .exportTensorboardTimeSeriesData(tensorboardTimeSeries)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
tensorboardTimeSeries	TensorboardTimeSeriesName Required. The resource name of the TensorboardTimeSeries to export data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Returns

Type	Description
TensorboardServiceClient.ExportTensorboardTimeSeriesDataPagedResponse

exportTensorboardTimeSeriesData(String tensorboardTimeSeries)

public final TensorboardServiceClient.ExportTensorboardTimeSeriesDataPagedResponse exportTensorboardTimeSeriesData(String tensorboardTimeSeries)

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

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String tensorboardTimeSeries =
       TensorboardTimeSeriesName.of(
               "[PROJECT]",
               "[LOCATION]",
               "[TENSORBOARD]",
               "[EXPERIMENT]",
               "[RUN]",
               "[TIME_SERIES]")
           .toString();
   for (TimeSeriesDataPoint element :
       tensorboardServiceClient
           .exportTensorboardTimeSeriesData(tensorboardTimeSeries)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
tensorboardTimeSeries	String Required. The resource name of the TensorboardTimeSeries to export data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Returns

Type	Description
TensorboardServiceClient.ExportTensorboardTimeSeriesDataPagedResponse

exportTensorboardTimeSeriesDataCallable()

public final UnaryCallable<ExportTensorboardTimeSeriesDataRequest,ExportTensorboardTimeSeriesDataResponse> exportTensorboardTimeSeriesDataCallable()

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

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ExportTensorboardTimeSeriesDataRequest request =
       ExportTensorboardTimeSeriesDataRequest.newBuilder()
           .setTensorboardTimeSeries(
               TensorboardTimeSeriesName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[TENSORBOARD]",
                       "[EXPERIMENT]",
                       "[RUN]",
                       "[TIME_SERIES]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ExportTensorboardTimeSeriesDataResponse response =
         tensorboardServiceClient.exportTensorboardTimeSeriesDataCallable().call(request);
     for (TimeSeriesDataPoint element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ExportTensorboardTimeSeriesDataRequest,ExportTensorboardTimeSeriesDataResponse>

exportTensorboardTimeSeriesDataPagedCallable()

public final UnaryCallable<ExportTensorboardTimeSeriesDataRequest,TensorboardServiceClient.ExportTensorboardTimeSeriesDataPagedResponse> exportTensorboardTimeSeriesDataPagedCallable()

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

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ExportTensorboardTimeSeriesDataRequest request =
       ExportTensorboardTimeSeriesDataRequest.newBuilder()
           .setTensorboardTimeSeries(
               TensorboardTimeSeriesName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[TENSORBOARD]",
                       "[EXPERIMENT]",
                       "[RUN]",
                       "[TIME_SERIES]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ExportTensorboardTimeSeriesDataRequest,ExportTensorboardTimeSeriesDataPagedResponse>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getSettings()

public final TensorboardServiceSettings getSettings()

Returns

Type	Description
TensorboardServiceSettings

getStub()

public TensorboardServiceStub getStub()

Returns

Type	Description
TensorboardServiceStub

getTensorboard(GetTensorboardRequest request)

public final Tensorboard getTensorboard(GetTensorboardRequest request)

Gets a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   GetTensorboardRequest request =
       GetTensorboardRequest.newBuilder()
           .setName(TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString())
           .build();
   Tensorboard response = tensorboardServiceClient.getTensorboard(request);
 }
 

Parameter

Name	Description
request	GetTensorboardRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Tensorboard

getTensorboard(TensorboardName name)

public final Tensorboard getTensorboard(TensorboardName name)

Gets a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardName name = TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
   Tensorboard response = tensorboardServiceClient.getTensorboard(name);
 }
 

Parameter

Name	Description
name	TensorboardName Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Returns

Type	Description
Tensorboard

getTensorboard(String name)

public final Tensorboard getTensorboard(String name)

Gets a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String name = TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString();
   Tensorboard response = tensorboardServiceClient.getTensorboard(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Returns

Type	Description
Tensorboard

getTensorboardCallable()

public final UnaryCallable<GetTensorboardRequest,Tensorboard> getTensorboardCallable()

Gets a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   GetTensorboardRequest request =
       GetTensorboardRequest.newBuilder()
           .setName(TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetTensorboardRequest,Tensorboard>

getTensorboardExperiment(GetTensorboardExperimentRequest request)

public final TensorboardExperiment getTensorboardExperiment(GetTensorboardExperimentRequest request)

Gets a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   GetTensorboardExperimentRequest request =
       GetTensorboardExperimentRequest.newBuilder()
           .setName(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .build();
   TensorboardExperiment response = tensorboardServiceClient.getTensorboardExperiment(request);
 }
 

Parameter

Name	Description
request	GetTensorboardExperimentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardExperiment

getTensorboardExperiment(TensorboardExperimentName name)

public final TensorboardExperiment getTensorboardExperiment(TensorboardExperimentName name)

Gets a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardExperimentName name =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
   TensorboardExperiment response = tensorboardServiceClient.getTensorboardExperiment(name);
 }
 

Parameter

Name	Description
name	TensorboardExperimentName Required. The name of the TensorboardExperiment resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

Returns

Type	Description
TensorboardExperiment

getTensorboardExperiment(String name)

public final TensorboardExperiment getTensorboardExperiment(String name)

Gets a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String name =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
           .toString();
   TensorboardExperiment response = tensorboardServiceClient.getTensorboardExperiment(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the TensorboardExperiment resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

Returns

Type	Description
TensorboardExperiment

getTensorboardExperimentCallable()

public final UnaryCallable<GetTensorboardExperimentRequest,TensorboardExperiment> getTensorboardExperimentCallable()

Gets a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   GetTensorboardExperimentRequest request =
       GetTensorboardExperimentRequest.newBuilder()
           .setName(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetTensorboardExperimentRequest,TensorboardExperiment>

getTensorboardRun(GetTensorboardRunRequest request)

public final TensorboardRun getTensorboardRun(GetTensorboardRunRequest request)

Gets a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   GetTensorboardRunRequest request =
       GetTensorboardRunRequest.newBuilder()
           .setName(
               TensorboardRunName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
                   .toString())
           .build();
   TensorboardRun response = tensorboardServiceClient.getTensorboardRun(request);
 }
 

Parameter

Name	Description
request	GetTensorboardRunRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardRun

getTensorboardRun(TensorboardRunName name)

public final TensorboardRun getTensorboardRun(TensorboardRunName name)

Gets a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardRunName name =
       TensorboardRunName.of(
           "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
   TensorboardRun response = tensorboardServiceClient.getTensorboardRun(name);
 }
 

Parameter

Name	Description
name	TensorboardRunName Required. The name of the TensorboardRun resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Returns

Type	Description
TensorboardRun

getTensorboardRun(String name)

public final TensorboardRun getTensorboardRun(String name)

Gets a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String name =
       TensorboardRunName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
           .toString();
   TensorboardRun response = tensorboardServiceClient.getTensorboardRun(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the TensorboardRun resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Returns

Type	Description
TensorboardRun

getTensorboardRunCallable()

public final UnaryCallable<GetTensorboardRunRequest,TensorboardRun> getTensorboardRunCallable()

Gets a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   GetTensorboardRunRequest request =
       GetTensorboardRunRequest.newBuilder()
           .setName(
               TensorboardRunName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
                   .toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetTensorboardRunRequest,TensorboardRun>

getTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request)

public final TensorboardTimeSeries getTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request)

Gets a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   GetTensorboardTimeSeriesRequest request =
       GetTensorboardTimeSeriesRequest.newBuilder()
           .setName(
               TensorboardTimeSeriesName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[TENSORBOARD]",
                       "[EXPERIMENT]",
                       "[RUN]",
                       "[TIME_SERIES]")
                   .toString())
           .build();
   TensorboardTimeSeries response = tensorboardServiceClient.getTensorboardTimeSeries(request);
 }
 

Parameter

Name	Description
request	GetTensorboardTimeSeriesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardTimeSeries

getTensorboardTimeSeries(TensorboardTimeSeriesName name)

public final TensorboardTimeSeries getTensorboardTimeSeries(TensorboardTimeSeriesName name)

Gets a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardTimeSeriesName name =
       TensorboardTimeSeriesName.of(
           "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
   TensorboardTimeSeries response = tensorboardServiceClient.getTensorboardTimeSeries(name);
 }
 

Parameter

Name	Description
name	TensorboardTimeSeriesName Required. The name of the TensorboardTimeSeries resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Returns

Type	Description
TensorboardTimeSeries

getTensorboardTimeSeries(String name)

public final TensorboardTimeSeries getTensorboardTimeSeries(String name)

Gets a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String name =
       TensorboardTimeSeriesName.of(
               "[PROJECT]",
               "[LOCATION]",
               "[TENSORBOARD]",
               "[EXPERIMENT]",
               "[RUN]",
               "[TIME_SERIES]")
           .toString();
   TensorboardTimeSeries response = tensorboardServiceClient.getTensorboardTimeSeries(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the TensorboardTimeSeries resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Returns

Type	Description
TensorboardTimeSeries

getTensorboardTimeSeriesCallable()

public final UnaryCallable<GetTensorboardTimeSeriesRequest,TensorboardTimeSeries> getTensorboardTimeSeriesCallable()

Gets a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   GetTensorboardTimeSeriesRequest request =
       GetTensorboardTimeSeriesRequest.newBuilder()
           .setName(
               TensorboardTimeSeriesName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[TENSORBOARD]",
                       "[EXPERIMENT]",
                       "[RUN]",
                       "[TIME_SERIES]")
                   .toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetTensorboardTimeSeriesRequest,TensorboardTimeSeries>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listTensorboardExperiments(ListTensorboardExperimentsRequest request)

public final TensorboardServiceClient.ListTensorboardExperimentsPagedResponse listTensorboardExperiments(ListTensorboardExperimentsRequest request)

Lists TensorboardExperiments in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ListTensorboardExperimentsRequest request =
       ListTensorboardExperimentsRequest.newBuilder()
           .setParent(TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (TensorboardExperiment element :
       tensorboardServiceClient.listTensorboardExperiments(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListTensorboardExperimentsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardServiceClient.ListTensorboardExperimentsPagedResponse

listTensorboardExperiments(TensorboardName parent)

public final TensorboardServiceClient.ListTensorboardExperimentsPagedResponse listTensorboardExperiments(TensorboardName parent)

Lists TensorboardExperiments in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardName parent = TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
   for (TensorboardExperiment element :
       tensorboardServiceClient.listTensorboardExperiments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	TensorboardName Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}'

Returns

Type	Description
TensorboardServiceClient.ListTensorboardExperimentsPagedResponse

listTensorboardExperiments(String parent)

public final TensorboardServiceClient.ListTensorboardExperimentsPagedResponse listTensorboardExperiments(String parent)

Lists TensorboardExperiments in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String parent = TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString();
   for (TensorboardExperiment element :
       tensorboardServiceClient.listTensorboardExperiments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}'

Returns

Type	Description
TensorboardServiceClient.ListTensorboardExperimentsPagedResponse

listTensorboardExperimentsCallable()

public final UnaryCallable<ListTensorboardExperimentsRequest,ListTensorboardExperimentsResponse> listTensorboardExperimentsCallable()

Lists TensorboardExperiments in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ListTensorboardExperimentsRequest request =
       ListTensorboardExperimentsRequest.newBuilder()
           .setParent(TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListTensorboardExperimentsResponse response =
         tensorboardServiceClient.listTensorboardExperimentsCallable().call(request);
     for (TensorboardExperiment element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListTensorboardExperimentsRequest,ListTensorboardExperimentsResponse>

listTensorboardExperimentsPagedCallable()

public final UnaryCallable<ListTensorboardExperimentsRequest,TensorboardServiceClient.ListTensorboardExperimentsPagedResponse> listTensorboardExperimentsPagedCallable()

Lists TensorboardExperiments in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ListTensorboardExperimentsRequest request =
       ListTensorboardExperimentsRequest.newBuilder()
           .setParent(TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListTensorboardExperimentsRequest,ListTensorboardExperimentsPagedResponse>

listTensorboardRuns(ListTensorboardRunsRequest request)

public final TensorboardServiceClient.ListTensorboardRunsPagedResponse listTensorboardRuns(ListTensorboardRunsRequest request)

Lists TensorboardRuns in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ListTensorboardRunsRequest request =
       ListTensorboardRunsRequest.newBuilder()
           .setParent(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (TensorboardRun element :
       tensorboardServiceClient.listTensorboardRuns(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListTensorboardRunsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardServiceClient.ListTensorboardRunsPagedResponse

listTensorboardRuns(TensorboardExperimentName parent)

public final TensorboardServiceClient.ListTensorboardRunsPagedResponse listTensorboardRuns(TensorboardExperimentName parent)

Lists TensorboardRuns in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardExperimentName parent =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
   for (TensorboardRun element :
       tensorboardServiceClient.listTensorboardRuns(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	TensorboardExperimentName Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}'

Returns

Type	Description
TensorboardServiceClient.ListTensorboardRunsPagedResponse

listTensorboardRuns(String parent)

public final TensorboardServiceClient.ListTensorboardRunsPagedResponse listTensorboardRuns(String parent)

Lists TensorboardRuns in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String parent =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
           .toString();
   for (TensorboardRun element :
       tensorboardServiceClient.listTensorboardRuns(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}'

Returns

Type	Description
TensorboardServiceClient.ListTensorboardRunsPagedResponse

listTensorboardRunsCallable()

public final UnaryCallable<ListTensorboardRunsRequest,ListTensorboardRunsResponse> listTensorboardRunsCallable()

Lists TensorboardRuns in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ListTensorboardRunsRequest request =
       ListTensorboardRunsRequest.newBuilder()
           .setParent(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListTensorboardRunsResponse response =
         tensorboardServiceClient.listTensorboardRunsCallable().call(request);
     for (TensorboardRun element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListTensorboardRunsRequest,ListTensorboardRunsResponse>

listTensorboardRunsPagedCallable()

public final UnaryCallable<ListTensorboardRunsRequest,TensorboardServiceClient.ListTensorboardRunsPagedResponse> listTensorboardRunsPagedCallable()

Lists TensorboardRuns in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ListTensorboardRunsRequest request =
       ListTensorboardRunsRequest.newBuilder()
           .setParent(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListTensorboardRunsRequest,ListTensorboardRunsPagedResponse>

listTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request)

public final TensorboardServiceClient.ListTensorboardTimeSeriesPagedResponse listTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request)

Lists TensorboardTimeSeries in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ListTensorboardTimeSeriesRequest request =
       ListTensorboardTimeSeriesRequest.newBuilder()
           .setParent(
               TensorboardRunName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (TensorboardTimeSeries element :
       tensorboardServiceClient.listTensorboardTimeSeries(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListTensorboardTimeSeriesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardServiceClient.ListTensorboardTimeSeriesPagedResponse

listTensorboardTimeSeries(TensorboardRunName parent)

public final TensorboardServiceClient.ListTensorboardTimeSeriesPagedResponse listTensorboardTimeSeries(TensorboardRunName parent)

Lists TensorboardTimeSeries in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardRunName parent =
       TensorboardRunName.of(
           "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
   for (TensorboardTimeSeries element :
       tensorboardServiceClient.listTensorboardTimeSeries(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	TensorboardRunName Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}'

Returns

Type	Description
TensorboardServiceClient.ListTensorboardTimeSeriesPagedResponse

listTensorboardTimeSeries(String parent)

public final TensorboardServiceClient.ListTensorboardTimeSeriesPagedResponse listTensorboardTimeSeries(String parent)

Lists TensorboardTimeSeries in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String parent =
       TensorboardRunName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
           .toString();
   for (TensorboardTimeSeries element :
       tensorboardServiceClient.listTensorboardTimeSeries(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}'

Returns

Type	Description
TensorboardServiceClient.ListTensorboardTimeSeriesPagedResponse

listTensorboardTimeSeriesCallable()

public final UnaryCallable<ListTensorboardTimeSeriesRequest,ListTensorboardTimeSeriesResponse> listTensorboardTimeSeriesCallable()

Lists TensorboardTimeSeries in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ListTensorboardTimeSeriesRequest request =
       ListTensorboardTimeSeriesRequest.newBuilder()
           .setParent(
               TensorboardRunName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListTensorboardTimeSeriesResponse response =
         tensorboardServiceClient.listTensorboardTimeSeriesCallable().call(request);
     for (TensorboardTimeSeries element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListTensorboardTimeSeriesRequest,ListTensorboardTimeSeriesResponse>

listTensorboardTimeSeriesPagedCallable()

public final UnaryCallable<ListTensorboardTimeSeriesRequest,TensorboardServiceClient.ListTensorboardTimeSeriesPagedResponse> listTensorboardTimeSeriesPagedCallable()

Lists TensorboardTimeSeries in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ListTensorboardTimeSeriesRequest request =
       ListTensorboardTimeSeriesRequest.newBuilder()
           .setParent(
               TensorboardRunName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListTensorboardTimeSeriesRequest,ListTensorboardTimeSeriesPagedResponse>

listTensorboards(ListTensorboardsRequest request)

public final TensorboardServiceClient.ListTensorboardsPagedResponse listTensorboards(ListTensorboardsRequest request)

Lists Tensorboards in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ListTensorboardsRequest request =
       ListTensorboardsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (Tensorboard element : tensorboardServiceClient.listTensorboards(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListTensorboardsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardServiceClient.ListTensorboardsPagedResponse

listTensorboards(LocationName parent)

public final TensorboardServiceClient.ListTensorboardsPagedResponse listTensorboards(LocationName parent)

Lists Tensorboards in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Tensorboard element : tensorboardServiceClient.listTensorboards(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	LocationName Required. The resource name of the Location to list Tensorboards. Format: projects/{project}/locations/{location}

Returns

Type	Description
TensorboardServiceClient.ListTensorboardsPagedResponse

listTensorboards(String parent)

public final TensorboardServiceClient.ListTensorboardsPagedResponse listTensorboards(String parent)

Lists Tensorboards in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Tensorboard element : tensorboardServiceClient.listTensorboards(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. The resource name of the Location to list Tensorboards. Format: projects/{project}/locations/{location}

Returns

Type	Description
TensorboardServiceClient.ListTensorboardsPagedResponse

listTensorboardsCallable()

public final UnaryCallable<ListTensorboardsRequest,ListTensorboardsResponse> listTensorboardsCallable()

Lists Tensorboards in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ListTensorboardsRequest request =
       ListTensorboardsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListTensorboardsResponse response =
         tensorboardServiceClient.listTensorboardsCallable().call(request);
     for (Tensorboard element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListTensorboardsRequest,ListTensorboardsResponse>

listTensorboardsPagedCallable()

public final UnaryCallable<ListTensorboardsRequest,TensorboardServiceClient.ListTensorboardsPagedResponse> listTensorboardsPagedCallable()

Lists Tensorboards in a Location.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ListTensorboardsRequest request =
       ListTensorboardsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListTensorboardsRequest,ListTensorboardsPagedResponse>

readTensorboardBlobDataCallable()

public final ServerStreamingCallable<ReadTensorboardBlobDataRequest,ReadTensorboardBlobDataResponse> readTensorboardBlobDataCallable()

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.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ReadTensorboardBlobDataRequest request =
       ReadTensorboardBlobDataRequest.newBuilder()
           .setTimeSeries(
               TensorboardTimeSeriesName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[TENSORBOARD]",
                       "[EXPERIMENT]",
                       "[RUN]",
                       "[TIME_SERIES]")
                   .toString())
           .addAllBlobIds(new ArrayList

Returns

Type	Description
ServerStreamingCallable<ReadTensorboardBlobDataRequest,ReadTensorboardBlobDataResponse>

readTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest request)

public final ReadTensorboardTimeSeriesDataResponse readTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest request)

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data will be returned. Otherwise, 1000 data points will be 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.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ReadTensorboardTimeSeriesDataRequest request =
       ReadTensorboardTimeSeriesDataRequest.newBuilder()
           .setTensorboardTimeSeries(
               TensorboardTimeSeriesName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[TENSORBOARD]",
                       "[EXPERIMENT]",
                       "[RUN]",
                       "[TIME_SERIES]")
                   .toString())
           .setMaxDataPoints(724001981)
           .setFilter("filter-1274492040")
           .build();
   ReadTensorboardTimeSeriesDataResponse response =
       tensorboardServiceClient.readTensorboardTimeSeriesData(request);
 }
 

Parameter

Name	Description
request	ReadTensorboardTimeSeriesDataRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ReadTensorboardTimeSeriesDataResponse

readTensorboardTimeSeriesData(TensorboardTimeSeriesName tensorboardTimeSeries)

public final ReadTensorboardTimeSeriesDataResponse readTensorboardTimeSeriesData(TensorboardTimeSeriesName tensorboardTimeSeries)

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data will be returned. Otherwise, 1000 data points will be 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.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardTimeSeriesName tensorboardTimeSeries =
       TensorboardTimeSeriesName.of(
           "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
   ReadTensorboardTimeSeriesDataResponse response =
       tensorboardServiceClient.readTensorboardTimeSeriesData(tensorboardTimeSeries);
 }
 

Parameter

Name	Description
tensorboardTimeSeries	TensorboardTimeSeriesName Required. The resource name of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Returns

Type	Description
ReadTensorboardTimeSeriesDataResponse

readTensorboardTimeSeriesData(String tensorboardTimeSeries)

public final ReadTensorboardTimeSeriesDataResponse readTensorboardTimeSeriesData(String tensorboardTimeSeries)

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data will be returned. Otherwise, 1000 data points will be 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.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String tensorboardTimeSeries =
       TensorboardTimeSeriesName.of(
               "[PROJECT]",
               "[LOCATION]",
               "[TENSORBOARD]",
               "[EXPERIMENT]",
               "[RUN]",
               "[TIME_SERIES]")
           .toString();
   ReadTensorboardTimeSeriesDataResponse response =
       tensorboardServiceClient.readTensorboardTimeSeriesData(tensorboardTimeSeries);
 }
 

Parameter

Name	Description
tensorboardTimeSeries	String Required. The resource name of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

Returns

Type	Description
ReadTensorboardTimeSeriesDataResponse

readTensorboardTimeSeriesDataCallable()

public final UnaryCallable<ReadTensorboardTimeSeriesDataRequest,ReadTensorboardTimeSeriesDataResponse> readTensorboardTimeSeriesDataCallable()

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data will be returned. Otherwise, 1000 data points will be 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.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   ReadTensorboardTimeSeriesDataRequest request =
       ReadTensorboardTimeSeriesDataRequest.newBuilder()
           .setTensorboardTimeSeries(
               TensorboardTimeSeriesName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[TENSORBOARD]",
                       "[EXPERIMENT]",
                       "[RUN]",
                       "[TIME_SERIES]")
                   .toString())
           .setMaxDataPoints(724001981)
           .setFilter("filter-1274492040")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ReadTensorboardTimeSeriesDataRequest,ReadTensorboardTimeSeriesDataResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateTensorboardAsync(Tensorboard tensorboard, FieldMask updateMask)

public final OperationFuture<Tensorboard,UpdateTensorboardOperationMetadata> updateTensorboardAsync(Tensorboard tensorboard, FieldMask updateMask)

Updates a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   Tensorboard tensorboard = Tensorboard.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Tensorboard response =
       tensorboardServiceClient.updateTensorboardAsync(tensorboard, updateMask).get();
 }
 

Parameters

Name	Description
tensorboard	Tensorboard Required. The Tensorboard's name field is used to identify the Tensorboard to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified.

Returns

Type	Description
OperationFuture<Tensorboard,UpdateTensorboardOperationMetadata>

updateTensorboardAsync(UpdateTensorboardRequest request)

public final OperationFuture<Tensorboard,UpdateTensorboardOperationMetadata> updateTensorboardAsync(UpdateTensorboardRequest request)

Updates a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   UpdateTensorboardRequest request =
       UpdateTensorboardRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTensorboard(Tensorboard.newBuilder().build())
           .build();
   Tensorboard response = tensorboardServiceClient.updateTensorboardAsync(request).get();
 }
 

Parameter

Name	Description
request	UpdateTensorboardRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Tensorboard,UpdateTensorboardOperationMetadata>

updateTensorboardCallable()

public final UnaryCallable<UpdateTensorboardRequest,Operation> updateTensorboardCallable()

Updates a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   UpdateTensorboardRequest request =
       UpdateTensorboardRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTensorboard(Tensorboard.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UpdateTensorboardRequest,Operation>

updateTensorboardExperiment(TensorboardExperiment tensorboardExperiment, FieldMask updateMask)

public final TensorboardExperiment updateTensorboardExperiment(TensorboardExperiment tensorboardExperiment, FieldMask updateMask)

Updates a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardExperiment tensorboardExperiment = TensorboardExperiment.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   TensorboardExperiment response =
       tensorboardServiceClient.updateTensorboardExperiment(tensorboardExperiment, updateMask);
 }
 

Parameters

Name	Description
tensorboardExperiment	TensorboardExperiment Required. The TensorboardExperiment's name field is used to identify the TensorboardExperiment to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified.

Returns

Type	Description
TensorboardExperiment

updateTensorboardExperiment(UpdateTensorboardExperimentRequest request)

public final TensorboardExperiment updateTensorboardExperiment(UpdateTensorboardExperimentRequest request)

Updates a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   UpdateTensorboardExperimentRequest request =
       UpdateTensorboardExperimentRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTensorboardExperiment(TensorboardExperiment.newBuilder().build())
           .build();
   TensorboardExperiment response =
       tensorboardServiceClient.updateTensorboardExperiment(request);
 }
 

Parameter

Name	Description
request	UpdateTensorboardExperimentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardExperiment

updateTensorboardExperimentCallable()

public final UnaryCallable<UpdateTensorboardExperimentRequest,TensorboardExperiment> updateTensorboardExperimentCallable()

Updates a TensorboardExperiment.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   UpdateTensorboardExperimentRequest request =
       UpdateTensorboardExperimentRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTensorboardExperiment(TensorboardExperiment.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UpdateTensorboardExperimentRequest,TensorboardExperiment>

updateTensorboardOperationCallable()

public final OperationCallable<UpdateTensorboardRequest,Tensorboard,UpdateTensorboardOperationMetadata> updateTensorboardOperationCallable()

Updates a Tensorboard.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   UpdateTensorboardRequest request =
       UpdateTensorboardRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTensorboard(Tensorboard.newBuilder().build())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<UpdateTensorboardRequest,Tensorboard,UpdateTensorboardOperationMetadata>

updateTensorboardRun(TensorboardRun tensorboardRun, FieldMask updateMask)

public final TensorboardRun updateTensorboardRun(TensorboardRun tensorboardRun, FieldMask updateMask)

Updates a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardRun tensorboardRun = TensorboardRun.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   TensorboardRun response =
       tensorboardServiceClient.updateTensorboardRun(tensorboardRun, updateMask);
 }
 

Parameters

Name	Description
tensorboardRun	TensorboardRun Required. The TensorboardRun's name field is used to identify the TensorboardRun to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified.

Returns

Type	Description
TensorboardRun

updateTensorboardRun(UpdateTensorboardRunRequest request)

public final TensorboardRun updateTensorboardRun(UpdateTensorboardRunRequest request)

Updates a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   UpdateTensorboardRunRequest request =
       UpdateTensorboardRunRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTensorboardRun(TensorboardRun.newBuilder().build())
           .build();
   TensorboardRun response = tensorboardServiceClient.updateTensorboardRun(request);
 }
 

Parameter

Name	Description
request	UpdateTensorboardRunRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardRun

updateTensorboardRunCallable()

public final UnaryCallable<UpdateTensorboardRunRequest,TensorboardRun> updateTensorboardRunCallable()

Updates a TensorboardRun.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   UpdateTensorboardRunRequest request =
       UpdateTensorboardRunRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTensorboardRun(TensorboardRun.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UpdateTensorboardRunRequest,TensorboardRun>

updateTensorboardTimeSeries(TensorboardTimeSeries tensorboardTimeSeries, FieldMask updateMask)

public final TensorboardTimeSeries updateTensorboardTimeSeries(TensorboardTimeSeries tensorboardTimeSeries, FieldMask updateMask)

Updates a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardTimeSeries tensorboardTimeSeries = TensorboardTimeSeries.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   TensorboardTimeSeries response =
       tensorboardServiceClient.updateTensorboardTimeSeries(tensorboardTimeSeries, updateMask);
 }
 

Parameters

Name	Description
tensorboardTimeSeries	TensorboardTimeSeries Required. The TensorboardTimeSeries' name field is used to identify the TensorboardTimeSeries to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified.

Returns

Type	Description
TensorboardTimeSeries

updateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request)

public final TensorboardTimeSeries updateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request)

Updates a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   UpdateTensorboardTimeSeriesRequest request =
       UpdateTensorboardTimeSeriesRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTensorboardTimeSeries(TensorboardTimeSeries.newBuilder().build())
           .build();
   TensorboardTimeSeries response =
       tensorboardServiceClient.updateTensorboardTimeSeries(request);
 }
 

Parameter

Name	Description
request	UpdateTensorboardTimeSeriesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
TensorboardTimeSeries

updateTensorboardTimeSeriesCallable()

public final UnaryCallable<UpdateTensorboardTimeSeriesRequest,TensorboardTimeSeries> updateTensorboardTimeSeriesCallable()

Updates a TensorboardTimeSeries.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   UpdateTensorboardTimeSeriesRequest request =
       UpdateTensorboardTimeSeriesRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTensorboardTimeSeries(TensorboardTimeSeries.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UpdateTensorboardTimeSeriesRequest,TensorboardTimeSeries>

writeTensorboardExperimentData(TensorboardExperimentName tensorboardExperiment, List<WriteTensorboardRunDataRequest> writeRunDataRequests)

public final WriteTensorboardExperimentDataResponse writeTensorboardExperimentData(TensorboardExperimentName tensorboardExperiment, List<WriteTensorboardRunDataRequest> writeRunDataRequests)

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

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardExperimentName tensorboardExperiment =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
   List

Parameters

Name	Description
tensorboardExperiment	TensorboardExperimentName Required. The resource name of the TensorboardExperiment to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
writeRunDataRequests	List<WriteTensorboardRunDataRequest> Required. Requests containing per-run TensorboardTimeSeries data to write.

Returns

Type	Description
WriteTensorboardExperimentDataResponse

writeTensorboardExperimentData(WriteTensorboardExperimentDataRequest request)

public final 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 will be returned.

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   WriteTensorboardExperimentDataRequest request =
       WriteTensorboardExperimentDataRequest.newBuilder()
           .setTensorboardExperiment(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .addAllWriteRunDataRequests(new ArrayList

Parameter

Name	Description
request	WriteTensorboardExperimentDataRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
WriteTensorboardExperimentDataResponse

writeTensorboardExperimentData(String tensorboardExperiment, List<WriteTensorboardRunDataRequest> writeRunDataRequests)

public final WriteTensorboardExperimentDataResponse writeTensorboardExperimentData(String tensorboardExperiment, List<WriteTensorboardRunDataRequest> writeRunDataRequests)

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

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String tensorboardExperiment =
       TensorboardExperimentName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
           .toString();
   List

Parameters

Name	Description
tensorboardExperiment	String Required. The resource name of the TensorboardExperiment to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
writeRunDataRequests	List<WriteTensorboardRunDataRequest> Required. Requests containing per-run TensorboardTimeSeries data to write.

Returns

Type	Description
WriteTensorboardExperimentDataResponse

writeTensorboardExperimentDataCallable()

public final UnaryCallable<WriteTensorboardExperimentDataRequest,WriteTensorboardExperimentDataResponse> writeTensorboardExperimentDataCallable()

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

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   WriteTensorboardExperimentDataRequest request =
       WriteTensorboardExperimentDataRequest.newBuilder()
           .setTensorboardExperiment(
               TensorboardExperimentName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]")
                   .toString())
           .addAllWriteRunDataRequests(new ArrayList

Returns

Type	Description
UnaryCallable<WriteTensorboardExperimentDataRequest,WriteTensorboardExperimentDataResponse>

writeTensorboardRunData(TensorboardRunName tensorboardRun, List<TimeSeriesData> timeSeriesData)

public final WriteTensorboardRunDataResponse writeTensorboardRunData(TensorboardRunName tensorboardRun, List<TimeSeriesData> timeSeriesData)

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

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   TensorboardRunName tensorboardRun =
       TensorboardRunName.of(
           "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
   List

Parameters

Name	Description
tensorboardRun	TensorboardRunName Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
timeSeriesData	List<TimeSeriesData> Required. The TensorboardTimeSeries data to write. Values with in a time series are indexed by their step value. Repeated writes to the same step will overwrite the existing value for that step. The upper limit of data points per write request is 5000.

Returns

Type	Description
WriteTensorboardRunDataResponse

writeTensorboardRunData(WriteTensorboardRunDataRequest request)

public final WriteTensorboardRunDataResponse writeTensorboardRunData(WriteTensorboardRunDataRequest request)

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

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   WriteTensorboardRunDataRequest request =
       WriteTensorboardRunDataRequest.newBuilder()
           .setTensorboardRun(
               TensorboardRunName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
                   .toString())
           .addAllTimeSeriesData(new ArrayList

Parameter

Name	Description
request	WriteTensorboardRunDataRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
WriteTensorboardRunDataResponse

writeTensorboardRunData(String tensorboardRun, List<TimeSeriesData> timeSeriesData)

public final WriteTensorboardRunDataResponse writeTensorboardRunData(String tensorboardRun, List<TimeSeriesData> timeSeriesData)

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

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   String tensorboardRun =
       TensorboardRunName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
           .toString();
   List

Parameters

Name	Description
tensorboardRun	String Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
timeSeriesData	List<TimeSeriesData> Required. The TensorboardTimeSeries data to write. Values with in a time series are indexed by their step value. Repeated writes to the same step will overwrite the existing value for that step. The upper limit of data points per write request is 5000.

Returns

Type	Description
WriteTensorboardRunDataResponse

writeTensorboardRunDataCallable()

public final UnaryCallable<WriteTensorboardRunDataRequest,WriteTensorboardRunDataResponse> writeTensorboardRunDataCallable()

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

Sample code:

 try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
   WriteTensorboardRunDataRequest request =
       WriteTensorboardRunDataRequest.newBuilder()
           .setTensorboardRun(
               TensorboardRunName.of(
                       "[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]")
                   .toString())
           .addAllTimeSeriesData(new ArrayList

Returns

Type	Description
UnaryCallable<WriteTensorboardRunDataRequest,WriteTensorboardRunDataResponse>