Class TensorboardServiceClient

public abstract class TensorboardServiceClient

TensorboardService client wrapper, for convenient use.

Inheritance

Object > TensorboardServiceClient

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

TensorboardService

Properties

CreateTensorboardOperationsClient

public virtual OperationsClient CreateTensorboardOperationsClient { get; }

The long-running operations client for CreateTensorboard.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the TensorboardService service, which is a host of "aiplatform.googleapis.com" and a port of 443.

Property Value
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default TensorboardService scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

DeleteTensorboardExperimentOperationsClient

public virtual OperationsClient DeleteTensorboardExperimentOperationsClient { get; }

The long-running operations client for DeleteTensorboardExperiment.

Property Value
TypeDescription
OperationsClient

DeleteTensorboardOperationsClient

public virtual OperationsClient DeleteTensorboardOperationsClient { get; }

The long-running operations client for DeleteTensorboard.

Property Value
TypeDescription
OperationsClient

DeleteTensorboardRunOperationsClient

public virtual OperationsClient DeleteTensorboardRunOperationsClient { get; }

The long-running operations client for DeleteTensorboardRun.

Property Value
TypeDescription
OperationsClient

DeleteTensorboardTimeSeriesOperationsClient

public virtual OperationsClient DeleteTensorboardTimeSeriesOperationsClient { get; }

The long-running operations client for DeleteTensorboardTimeSeries.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual TensorboardService.TensorboardServiceClient GrpcClient { get; }

The underlying gRPC TensorboardService client

Property Value
TypeDescription
TensorboardService.TensorboardServiceClient

UpdateTensorboardOperationsClient

public virtual OperationsClient UpdateTensorboardOperationsClient { get; }

The long-running operations client for UpdateTensorboard.

Property Value
TypeDescription
OperationsClient

Methods

BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest, CallSettings)

public virtual BatchCreateTensorboardRunsResponse BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest request, CallSettings callSettings = null)

Batch create TensorboardRuns.

Parameters
NameDescription
requestBatchCreateTensorboardRunsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BatchCreateTensorboardRunsResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
BatchCreateTensorboardRunsRequest request = new BatchCreateTensorboardRunsRequest
{
    ParentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    Requests =
    {
        new CreateTensorboardRunRequest(),
    },
};
// Make the request
BatchCreateTensorboardRunsResponse response = tensorboardServiceClient.BatchCreateTensorboardRuns(request);

BatchCreateTensorboardRuns(TensorboardExperimentName, IEnumerable<CreateTensorboardRunRequest>, CallSettings)

public virtual BatchCreateTensorboardRunsResponse BatchCreateTensorboardRuns(TensorboardExperimentName parent, IEnumerable<CreateTensorboardRunRequest> requests, CallSettings callSettings = null)

Batch create TensorboardRuns.

Parameters
NameDescription
parentTensorboardExperimentName

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.

requestsIEnumerable<CreateTensorboardRunRequest>

Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BatchCreateTensorboardRunsResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardExperimentName parent = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
IEnumerable<CreateTensorboardRunRequest> requests = new CreateTensorboardRunRequest[]
{
    new CreateTensorboardRunRequest(),
};
// Make the request
BatchCreateTensorboardRunsResponse response = tensorboardServiceClient.BatchCreateTensorboardRuns(parent, requests);

BatchCreateTensorboardRuns(String, IEnumerable<CreateTensorboardRunRequest>, CallSettings)

public virtual BatchCreateTensorboardRunsResponse BatchCreateTensorboardRuns(string parent, IEnumerable<CreateTensorboardRunRequest> requests, CallSettings callSettings = null)

Batch create TensorboardRuns.

Parameters
NameDescription
parentString

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.

requestsIEnumerable<CreateTensorboardRunRequest>

Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BatchCreateTensorboardRunsResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
IEnumerable<CreateTensorboardRunRequest> requests = new CreateTensorboardRunRequest[]
{
    new CreateTensorboardRunRequest(),
};
// Make the request
BatchCreateTensorboardRunsResponse response = tensorboardServiceClient.BatchCreateTensorboardRuns(parent, requests);

BatchCreateTensorboardRunsAsync(BatchCreateTensorboardRunsRequest, CallSettings)

public virtual Task<BatchCreateTensorboardRunsResponse> BatchCreateTensorboardRunsAsync(BatchCreateTensorboardRunsRequest request, CallSettings callSettings = null)

Batch create TensorboardRuns.

Parameters
NameDescription
requestBatchCreateTensorboardRunsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<BatchCreateTensorboardRunsResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateTensorboardRunsRequest request = new BatchCreateTensorboardRunsRequest
{
    ParentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    Requests =
    {
        new CreateTensorboardRunRequest(),
    },
};
// Make the request
BatchCreateTensorboardRunsResponse response = await tensorboardServiceClient.BatchCreateTensorboardRunsAsync(request);

BatchCreateTensorboardRunsAsync(BatchCreateTensorboardRunsRequest, CancellationToken)

public virtual Task<BatchCreateTensorboardRunsResponse> BatchCreateTensorboardRunsAsync(BatchCreateTensorboardRunsRequest request, CancellationToken cancellationToken)

Batch create TensorboardRuns.

Parameters
NameDescription
requestBatchCreateTensorboardRunsRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<BatchCreateTensorboardRunsResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateTensorboardRunsRequest request = new BatchCreateTensorboardRunsRequest
{
    ParentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    Requests =
    {
        new CreateTensorboardRunRequest(),
    },
};
// Make the request
BatchCreateTensorboardRunsResponse response = await tensorboardServiceClient.BatchCreateTensorboardRunsAsync(request);

BatchCreateTensorboardRunsAsync(TensorboardExperimentName, IEnumerable<CreateTensorboardRunRequest>, CallSettings)

public virtual Task<BatchCreateTensorboardRunsResponse> BatchCreateTensorboardRunsAsync(TensorboardExperimentName parent, IEnumerable<CreateTensorboardRunRequest> requests, CallSettings callSettings = null)

Batch create TensorboardRuns.

Parameters
NameDescription
parentTensorboardExperimentName

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.

requestsIEnumerable<CreateTensorboardRunRequest>

Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<BatchCreateTensorboardRunsResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardExperimentName parent = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
IEnumerable<CreateTensorboardRunRequest> requests = new CreateTensorboardRunRequest[]
{
    new CreateTensorboardRunRequest(),
};
// Make the request
BatchCreateTensorboardRunsResponse response = await tensorboardServiceClient.BatchCreateTensorboardRunsAsync(parent, requests);

BatchCreateTensorboardRunsAsync(TensorboardExperimentName, IEnumerable<CreateTensorboardRunRequest>, CancellationToken)

public virtual Task<BatchCreateTensorboardRunsResponse> BatchCreateTensorboardRunsAsync(TensorboardExperimentName parent, IEnumerable<CreateTensorboardRunRequest> requests, CancellationToken cancellationToken)

Batch create TensorboardRuns.

Parameters
NameDescription
parentTensorboardExperimentName

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.

requestsIEnumerable<CreateTensorboardRunRequest>

Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<BatchCreateTensorboardRunsResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardExperimentName parent = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
IEnumerable<CreateTensorboardRunRequest> requests = new CreateTensorboardRunRequest[]
{
    new CreateTensorboardRunRequest(),
};
// Make the request
BatchCreateTensorboardRunsResponse response = await tensorboardServiceClient.BatchCreateTensorboardRunsAsync(parent, requests);

BatchCreateTensorboardRunsAsync(String, IEnumerable<CreateTensorboardRunRequest>, CallSettings)

public virtual Task<BatchCreateTensorboardRunsResponse> BatchCreateTensorboardRunsAsync(string parent, IEnumerable<CreateTensorboardRunRequest> requests, CallSettings callSettings = null)

Batch create TensorboardRuns.

Parameters
NameDescription
parentString

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.

requestsIEnumerable<CreateTensorboardRunRequest>

Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<BatchCreateTensorboardRunsResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
IEnumerable<CreateTensorboardRunRequest> requests = new CreateTensorboardRunRequest[]
{
    new CreateTensorboardRunRequest(),
};
// Make the request
BatchCreateTensorboardRunsResponse response = await tensorboardServiceClient.BatchCreateTensorboardRunsAsync(parent, requests);

BatchCreateTensorboardRunsAsync(String, IEnumerable<CreateTensorboardRunRequest>, CancellationToken)

public virtual Task<BatchCreateTensorboardRunsResponse> BatchCreateTensorboardRunsAsync(string parent, IEnumerable<CreateTensorboardRunRequest> requests, CancellationToken cancellationToken)

Batch create TensorboardRuns.

Parameters
NameDescription
parentString

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.

requestsIEnumerable<CreateTensorboardRunRequest>

Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<BatchCreateTensorboardRunsResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
IEnumerable<CreateTensorboardRunRequest> requests = new CreateTensorboardRunRequest[]
{
    new CreateTensorboardRunRequest(),
};
// Make the request
BatchCreateTensorboardRunsResponse response = await tensorboardServiceClient.BatchCreateTensorboardRunsAsync(parent, requests);

BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest, CallSettings)

public virtual BatchCreateTensorboardTimeSeriesResponse BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
NameDescription
requestBatchCreateTensorboardTimeSeriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BatchCreateTensorboardTimeSeriesResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
BatchCreateTensorboardTimeSeriesRequest request = new BatchCreateTensorboardTimeSeriesRequest
{
    ParentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    Requests =
    {
        new CreateTensorboardTimeSeriesRequest(),
    },
};
// Make the request
BatchCreateTensorboardTimeSeriesResponse response = tensorboardServiceClient.BatchCreateTensorboardTimeSeries(request);

BatchCreateTensorboardTimeSeries(TensorboardExperimentName, IEnumerable<CreateTensorboardTimeSeriesRequest>, CallSettings)

public virtual BatchCreateTensorboardTimeSeriesResponse BatchCreateTensorboardTimeSeries(TensorboardExperimentName parent, IEnumerable<CreateTensorboardTimeSeriesRequest> requests, CallSettings callSettings = null)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
NameDescription
parentTensorboardExperimentName

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.

requestsIEnumerable<CreateTensorboardTimeSeriesRequest>

Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BatchCreateTensorboardTimeSeriesResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardExperimentName parent = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
IEnumerable<CreateTensorboardTimeSeriesRequest> requests = new CreateTensorboardTimeSeriesRequest[]
{
    new CreateTensorboardTimeSeriesRequest(),
};
// Make the request
BatchCreateTensorboardTimeSeriesResponse response = tensorboardServiceClient.BatchCreateTensorboardTimeSeries(parent, requests);

BatchCreateTensorboardTimeSeries(String, IEnumerable<CreateTensorboardTimeSeriesRequest>, CallSettings)

public virtual BatchCreateTensorboardTimeSeriesResponse BatchCreateTensorboardTimeSeries(string parent, IEnumerable<CreateTensorboardTimeSeriesRequest> requests, CallSettings callSettings = null)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
NameDescription
parentString

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.

requestsIEnumerable<CreateTensorboardTimeSeriesRequest>

Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BatchCreateTensorboardTimeSeriesResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
IEnumerable<CreateTensorboardTimeSeriesRequest> requests = new CreateTensorboardTimeSeriesRequest[]
{
    new CreateTensorboardTimeSeriesRequest(),
};
// Make the request
BatchCreateTensorboardTimeSeriesResponse response = tensorboardServiceClient.BatchCreateTensorboardTimeSeries(parent, requests);

BatchCreateTensorboardTimeSeriesAsync(BatchCreateTensorboardTimeSeriesRequest, CallSettings)

public virtual Task<BatchCreateTensorboardTimeSeriesResponse> BatchCreateTensorboardTimeSeriesAsync(BatchCreateTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
NameDescription
requestBatchCreateTensorboardTimeSeriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<BatchCreateTensorboardTimeSeriesResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateTensorboardTimeSeriesRequest request = new BatchCreateTensorboardTimeSeriesRequest
{
    ParentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    Requests =
    {
        new CreateTensorboardTimeSeriesRequest(),
    },
};
// Make the request
BatchCreateTensorboardTimeSeriesResponse response = await tensorboardServiceClient.BatchCreateTensorboardTimeSeriesAsync(request);

BatchCreateTensorboardTimeSeriesAsync(BatchCreateTensorboardTimeSeriesRequest, CancellationToken)

public virtual Task<BatchCreateTensorboardTimeSeriesResponse> BatchCreateTensorboardTimeSeriesAsync(BatchCreateTensorboardTimeSeriesRequest request, CancellationToken cancellationToken)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
NameDescription
requestBatchCreateTensorboardTimeSeriesRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<BatchCreateTensorboardTimeSeriesResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateTensorboardTimeSeriesRequest request = new BatchCreateTensorboardTimeSeriesRequest
{
    ParentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    Requests =
    {
        new CreateTensorboardTimeSeriesRequest(),
    },
};
// Make the request
BatchCreateTensorboardTimeSeriesResponse response = await tensorboardServiceClient.BatchCreateTensorboardTimeSeriesAsync(request);

BatchCreateTensorboardTimeSeriesAsync(TensorboardExperimentName, IEnumerable<CreateTensorboardTimeSeriesRequest>, CallSettings)

public virtual Task<BatchCreateTensorboardTimeSeriesResponse> BatchCreateTensorboardTimeSeriesAsync(TensorboardExperimentName parent, IEnumerable<CreateTensorboardTimeSeriesRequest> requests, CallSettings callSettings = null)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
NameDescription
parentTensorboardExperimentName

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.

requestsIEnumerable<CreateTensorboardTimeSeriesRequest>

Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<BatchCreateTensorboardTimeSeriesResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardExperimentName parent = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
IEnumerable<CreateTensorboardTimeSeriesRequest> requests = new CreateTensorboardTimeSeriesRequest[]
{
    new CreateTensorboardTimeSeriesRequest(),
};
// Make the request
BatchCreateTensorboardTimeSeriesResponse response = await tensorboardServiceClient.BatchCreateTensorboardTimeSeriesAsync(parent, requests);

BatchCreateTensorboardTimeSeriesAsync(TensorboardExperimentName, IEnumerable<CreateTensorboardTimeSeriesRequest>, CancellationToken)

public virtual Task<BatchCreateTensorboardTimeSeriesResponse> BatchCreateTensorboardTimeSeriesAsync(TensorboardExperimentName parent, IEnumerable<CreateTensorboardTimeSeriesRequest> requests, CancellationToken cancellationToken)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
NameDescription
parentTensorboardExperimentName

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.

requestsIEnumerable<CreateTensorboardTimeSeriesRequest>

Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<BatchCreateTensorboardTimeSeriesResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardExperimentName parent = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
IEnumerable<CreateTensorboardTimeSeriesRequest> requests = new CreateTensorboardTimeSeriesRequest[]
{
    new CreateTensorboardTimeSeriesRequest(),
};
// Make the request
BatchCreateTensorboardTimeSeriesResponse response = await tensorboardServiceClient.BatchCreateTensorboardTimeSeriesAsync(parent, requests);

BatchCreateTensorboardTimeSeriesAsync(String, IEnumerable<CreateTensorboardTimeSeriesRequest>, CallSettings)

public virtual Task<BatchCreateTensorboardTimeSeriesResponse> BatchCreateTensorboardTimeSeriesAsync(string parent, IEnumerable<CreateTensorboardTimeSeriesRequest> requests, CallSettings callSettings = null)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
NameDescription
parentString

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.

requestsIEnumerable<CreateTensorboardTimeSeriesRequest>

Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<BatchCreateTensorboardTimeSeriesResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
IEnumerable<CreateTensorboardTimeSeriesRequest> requests = new CreateTensorboardTimeSeriesRequest[]
{
    new CreateTensorboardTimeSeriesRequest(),
};
// Make the request
BatchCreateTensorboardTimeSeriesResponse response = await tensorboardServiceClient.BatchCreateTensorboardTimeSeriesAsync(parent, requests);

BatchCreateTensorboardTimeSeriesAsync(String, IEnumerable<CreateTensorboardTimeSeriesRequest>, CancellationToken)

public virtual Task<BatchCreateTensorboardTimeSeriesResponse> BatchCreateTensorboardTimeSeriesAsync(string parent, IEnumerable<CreateTensorboardTimeSeriesRequest> requests, CancellationToken cancellationToken)

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
NameDescription
parentString

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.

requestsIEnumerable<CreateTensorboardTimeSeriesRequest>

Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<BatchCreateTensorboardTimeSeriesResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
IEnumerable<CreateTensorboardTimeSeriesRequest> requests = new CreateTensorboardTimeSeriesRequest[]
{
    new CreateTensorboardTimeSeriesRequest(),
};
// Make the request
BatchCreateTensorboardTimeSeriesResponse response = await tensorboardServiceClient.BatchCreateTensorboardTimeSeriesAsync(parent, requests);

BatchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest, CallSettings)

public virtual BatchReadTensorboardTimeSeriesDataResponse BatchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest request, CallSettings callSettings = null)

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.

Parameters
NameDescription
requestBatchReadTensorboardTimeSeriesDataRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
BatchReadTensorboardTimeSeriesDataRequest request = new BatchReadTensorboardTimeSeriesDataRequest
{
    TensorboardAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
    TimeSeriesAsTensorboardTimeSeriesNames =
    {
        TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
    },
};
// Make the request
BatchReadTensorboardTimeSeriesDataResponse response = tensorboardServiceClient.BatchReadTensorboardTimeSeriesData(request);

BatchReadTensorboardTimeSeriesData(TensorboardName, CallSettings)

public virtual BatchReadTensorboardTimeSeriesDataResponse BatchReadTensorboardTimeSeriesData(TensorboardName tensorboard, CallSettings callSettings = null)

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.

Parameters
NameDescription
tensorboardTensorboardName

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][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series] must be sub resources of this Tensorboard.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardName tensorboard = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
// Make the request
BatchReadTensorboardTimeSeriesDataResponse response = tensorboardServiceClient.BatchReadTensorboardTimeSeriesData(tensorboard);

BatchReadTensorboardTimeSeriesData(String, CallSettings)

public virtual BatchReadTensorboardTimeSeriesDataResponse BatchReadTensorboardTimeSeriesData(string tensorboard, CallSettings callSettings = null)

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.

Parameters
NameDescription
tensorboardString

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][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series] must be sub resources of this Tensorboard.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BatchReadTensorboardTimeSeriesDataResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string tensorboard = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]";
// Make the request
BatchReadTensorboardTimeSeriesDataResponse response = tensorboardServiceClient.BatchReadTensorboardTimeSeriesData(tensorboard);

BatchReadTensorboardTimeSeriesDataAsync(BatchReadTensorboardTimeSeriesDataRequest, CallSettings)

public virtual Task<BatchReadTensorboardTimeSeriesDataResponse> BatchReadTensorboardTimeSeriesDataAsync(BatchReadTensorboardTimeSeriesDataRequest request, CallSettings callSettings = null)

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.

Parameters
NameDescription
requestBatchReadTensorboardTimeSeriesDataRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<BatchReadTensorboardTimeSeriesDataResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
BatchReadTensorboardTimeSeriesDataRequest request = new BatchReadTensorboardTimeSeriesDataRequest
{
    TensorboardAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
    TimeSeriesAsTensorboardTimeSeriesNames =
    {
        TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
    },
};
// Make the request
BatchReadTensorboardTimeSeriesDataResponse response = await tensorboardServiceClient.BatchReadTensorboardTimeSeriesDataAsync(request);

BatchReadTensorboardTimeSeriesDataAsync(BatchReadTensorboardTimeSeriesDataRequest, CancellationToken)

public virtual Task<BatchReadTensorboardTimeSeriesDataResponse> BatchReadTensorboardTimeSeriesDataAsync(BatchReadTensorboardTimeSeriesDataRequest request, CancellationToken cancellationToken)

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.

Parameters
NameDescription
requestBatchReadTensorboardTimeSeriesDataRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<BatchReadTensorboardTimeSeriesDataResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
BatchReadTensorboardTimeSeriesDataRequest request = new BatchReadTensorboardTimeSeriesDataRequest
{
    TensorboardAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
    TimeSeriesAsTensorboardTimeSeriesNames =
    {
        TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
    },
};
// Make the request
BatchReadTensorboardTimeSeriesDataResponse response = await tensorboardServiceClient.BatchReadTensorboardTimeSeriesDataAsync(request);

BatchReadTensorboardTimeSeriesDataAsync(TensorboardName, CallSettings)

public virtual Task<BatchReadTensorboardTimeSeriesDataResponse> BatchReadTensorboardTimeSeriesDataAsync(TensorboardName tensorboard, CallSettings callSettings = null)

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.

Parameters
NameDescription
tensorboardTensorboardName

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][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series] must be sub resources of this Tensorboard.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<BatchReadTensorboardTimeSeriesDataResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardName tensorboard = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
// Make the request
BatchReadTensorboardTimeSeriesDataResponse response = await tensorboardServiceClient.BatchReadTensorboardTimeSeriesDataAsync(tensorboard);

BatchReadTensorboardTimeSeriesDataAsync(TensorboardName, CancellationToken)

public virtual Task<BatchReadTensorboardTimeSeriesDataResponse> BatchReadTensorboardTimeSeriesDataAsync(TensorboardName tensorboard, CancellationToken cancellationToken)

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.

Parameters
NameDescription
tensorboardTensorboardName

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][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series] must be sub resources of this Tensorboard.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<BatchReadTensorboardTimeSeriesDataResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardName tensorboard = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
// Make the request
BatchReadTensorboardTimeSeriesDataResponse response = await tensorboardServiceClient.BatchReadTensorboardTimeSeriesDataAsync(tensorboard);

BatchReadTensorboardTimeSeriesDataAsync(String, CallSettings)

public virtual Task<BatchReadTensorboardTimeSeriesDataResponse> BatchReadTensorboardTimeSeriesDataAsync(string tensorboard, CallSettings callSettings = null)

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.

Parameters
NameDescription
tensorboardString

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][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series] must be sub resources of this Tensorboard.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<BatchReadTensorboardTimeSeriesDataResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string tensorboard = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]";
// Make the request
BatchReadTensorboardTimeSeriesDataResponse response = await tensorboardServiceClient.BatchReadTensorboardTimeSeriesDataAsync(tensorboard);

BatchReadTensorboardTimeSeriesDataAsync(String, CancellationToken)

public virtual Task<BatchReadTensorboardTimeSeriesDataResponse> BatchReadTensorboardTimeSeriesDataAsync(string tensorboard, CancellationToken cancellationToken)

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.

Parameters
NameDescription
tensorboardString

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][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series] must be sub resources of this Tensorboard.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<BatchReadTensorboardTimeSeriesDataResponse>

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string tensorboard = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]";
// Make the request
BatchReadTensorboardTimeSeriesDataResponse response = await tensorboardServiceClient.BatchReadTensorboardTimeSeriesDataAsync(tensorboard);

Create()

public static TensorboardServiceClient Create()

Synchronously creates a TensorboardServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use TensorboardServiceClientBuilder .

Returns
TypeDescription
TensorboardServiceClient

The created TensorboardServiceClient.

CreateAsync(CancellationToken)

public static Task<TensorboardServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a TensorboardServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use TensorboardServiceClientBuilder .

Parameter
NameDescription
cancellationTokenCancellationToken

Th