Cloud AI Platform v1 API - Class TensorboardServiceClient (2.25.0)

public abstract class TensorboardServiceClient

Reference documentation and code samples for the Cloud AI Platform v1 API 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
IReadOnlyListstring
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
TensorboardServiceTensorboardServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

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.

requestsIEnumerableCreateTensorboardRunRequest

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.

requestsIEnumerableCreateTensorboardRunRequest

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
TaskBatchCreateTensorboardRunsResponse

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
TaskBatchCreateTensorboardRunsResponse

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.

requestsIEnumerableCreateTensorboardRunRequest

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
TaskBatchCreateTensorboardRunsResponse

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.

requestsIEnumerableCreateTensorboardRunRequest

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
TaskBatchCreateTensorboardRunsResponse

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.

requestsIEnumerableCreateTensorboardRunRequest

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
TaskBatchCreateTensorboardRunsResponse

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.

requestsIEnumerableCreateTensorboardRunRequest

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
TaskBatchCreateTensorboardRunsResponse

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.

requestsIEnumerableCreateTensorboardTimeSeriesRequest

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.

requestsIEnumerableCreateTensorboardTimeSeriesRequest

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
TaskBatchCreateTensorboardTimeSeriesResponse

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
TaskBatchCreateTensorboardTimeSeriesResponse

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.

requestsIEnumerableCreateTensorboardTimeSeriesRequest

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
TaskBatchCreateTensorboardTimeSeriesResponse

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.

requestsIEnumerableCreateTensorboardTimeSeriesRequest

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
TaskBatchCreateTensorboardTimeSeriesResponse

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.

requestsIEnumerableCreateTensorboardTimeSeriesRequest

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
TaskBatchCreateTensorboardTimeSeriesResponse

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.

requestsIEnumerableCreateTensorboardTimeSeriesRequest

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
TaskBatchCreateTensorboardTimeSeriesResponse

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 is returned. Otherwise, the number limit of data points is 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 is returned. Otherwise, the number limit of data points is 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 is returned. Otherwise, the number limit of data points is 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 is returned. Otherwise, the number limit of data points is 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
TaskBatchReadTensorboardTimeSeriesDataResponse

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 is returned. Otherwise, the number limit of data points is 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
TaskBatchReadTensorboardTimeSeriesDataResponse

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 is returned. Otherwise, the number limit of data points is 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
TaskBatchReadTensorboardTimeSeriesDataResponse

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 is returned. Otherwise, the number limit of data points is 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
TaskBatchReadTensorboardTimeSeriesDataResponse

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 is returned. Otherwise, the number limit of data points is 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
TaskBatchReadTensorboardTimeSeriesDataResponse

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 is returned. Otherwise, the number limit of data points is 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
TaskBatchReadTensorboardTimeSeriesDataResponse

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)

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

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
TaskTensorboardServiceClient

The task representing the created TensorboardServiceClient.

CreateTensorboard(CreateTensorboardRequest, CallSettings)

public virtual Operation<Tensorboard, CreateTensorboardOperationMetadata> CreateTensorboard(CreateTensorboardRequest request, CallSettings callSettings = null)

Creates a Tensorboard.

Parameters
NameDescription
requestCreateTensorboardRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationTensorboardCreateTensorboardOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
CreateTensorboardRequest request = new CreateTensorboardRequest
{
    ParentAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
    Tensorboard = new Tensorboard(),
};
// Make the request
Operation<Tensorboard, CreateTensorboardOperationMetadata> response = tensorboardServiceClient.CreateTensorboard(request);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, CreateTensorboardOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, CreateTensorboardOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceCreateTensorboard(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

CreateTensorboard(TensorboardName, Tensorboard, CallSettings)

public virtual Operation<Tensorboard, CreateTensorboardOperationMetadata> CreateTensorboard(TensorboardName parent, Tensorboard tensorboard, CallSettings callSettings = null)

Creates a Tensorboard.

Parameters
NameDescription
parentTensorboardName

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

tensorboardTensorboard

Required. The Tensorboard to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationTensorboardCreateTensorboardOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardName parent = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
Tensorboard tensorboard = new Tensorboard();
// Make the request
Operation<Tensorboard, CreateTensorboardOperationMetadata> response = tensorboardServiceClient.CreateTensorboard(parent, tensorboard);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, CreateTensorboardOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, CreateTensorboardOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceCreateTensorboard(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

CreateTensorboard(string, Tensorboard, CallSettings)

public virtual Operation<Tensorboard, CreateTensorboardOperationMetadata> CreateTensorboard(string parent, Tensorboard tensorboard, CallSettings callSettings = null)

Creates a Tensorboard.

Parameters
NameDescription
parentstring

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

tensorboardTensorboard

Required. The Tensorboard to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationTensorboardCreateTensorboardOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]";
Tensorboard tensorboard = new Tensorboard();
// Make the request
Operation<Tensorboard, CreateTensorboardOperationMetadata> response = tensorboardServiceClient.CreateTensorboard(parent, tensorboard);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, CreateTensorboardOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, CreateTensorboardOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceCreateTensorboard(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

CreateTensorboardAsync(CreateTensorboardRequest, CallSettings)

public virtual Task<Operation<Tensorboard, CreateTensorboardOperationMetadata>> CreateTensorboardAsync(CreateTensorboardRequest request, CallSettings callSettings = null)

Creates a Tensorboard.

Parameters
NameDescription
requestCreateTensorboardRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationTensorboardCreateTensorboardOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTensorboardRequest request = new CreateTensorboardRequest
{
    ParentAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
    Tensorboard = new Tensorboard(),
};
// Make the request
Operation<Tensorboard, CreateTensorboardOperationMetadata> response = await tensorboardServiceClient.CreateTensorboardAsync(request);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, CreateTensorboardOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, CreateTensorboardOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceCreateTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

CreateTensorboardAsync(CreateTensorboardRequest, CancellationToken)

public virtual Task<Operation<Tensorboard, CreateTensorboardOperationMetadata>> CreateTensorboardAsync(CreateTensorboardRequest request, CancellationToken cancellationToken)

Creates a Tensorboard.

Parameters
NameDescription
requestCreateTensorboardRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationTensorboardCreateTensorboardOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTensorboardRequest request = new CreateTensorboardRequest
{
    ParentAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
    Tensorboard = new Tensorboard(),
};
// Make the request
Operation<Tensorboard, CreateTensorboardOperationMetadata> response = await tensorboardServiceClient.CreateTensorboardAsync(request);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, CreateTensorboardOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, CreateTensorboardOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceCreateTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

CreateTensorboardAsync(TensorboardName, Tensorboard, CallSettings)

public virtual Task<Operation<Tensorboard, CreateTensorboardOperationMetadata>> CreateTensorboardAsync(TensorboardName parent, Tensorboard tensorboard, CallSettings callSettings = null)

Creates a Tensorboard.

Parameters
NameDescription
parentTensorboardName

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

tensorboardTensorboard

Required. The Tensorboard to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationTensorboardCreateTensorboardOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardName parent = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
Tensorboard tensorboard = new Tensorboard();
// Make the request
Operation<Tensorboard, CreateTensorboardOperationMetadata> response = await tensorboardServiceClient.CreateTensorboardAsync(parent, tensorboard);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, CreateTensorboardOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, CreateTensorboardOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceCreateTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

CreateTensorboardAsync(TensorboardName, Tensorboard, CancellationToken)

public virtual Task<Operation<Tensorboard, CreateTensorboardOperationMetadata>> CreateTensorboardAsync(TensorboardName parent, Tensorboard tensorboard, CancellationToken cancellationToken)

Creates a Tensorboard.

Parameters
NameDescription
parentTensorboardName

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

tensorboardTensorboard

Required. The Tensorboard to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationTensorboardCreateTensorboardOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardName parent = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
Tensorboard tensorboard = new Tensorboard();
// Make the request
Operation<Tensorboard, CreateTensorboardOperationMetadata> response = await tensorboardServiceClient.CreateTensorboardAsync(parent, tensorboard);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, CreateTensorboardOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, CreateTensorboardOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceCreateTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

CreateTensorboardAsync(string, Tensorboard, CallSettings)

public virtual Task<Operation<Tensorboard, CreateTensorboardOperationMetadata>> CreateTensorboardAsync(string parent, Tensorboard tensorboard, CallSettings callSettings = null)

Creates a Tensorboard.

Parameters
NameDescription
parentstring

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

tensorboardTensorboard

Required. The Tensorboard to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationTensorboardCreateTensorboardOperationMetadata

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]";
Tensorboard tensorboard = new Tensorboard();
// Make the request
Operation<Tensorboard, CreateTensorboardOperationMetadata> response = await tensorboardServiceClient.CreateTensorboardAsync(parent, tensorboard);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, CreateTensorboardOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, CreateTensorboardOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceCreateTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

CreateTensorboardAsync(string, Tensorboard, CancellationToken)

public virtual Task<Operation<Tensorboard, CreateTensorboardOperationMetadata>> CreateTensorboardAsync(string parent, Tensorboard tensorboard, CancellationToken cancellationToken)

Creates a Tensorboard.

Parameters
NameDescription
parentstring

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

tensorboardTensorboard

Required. The Tensorboard to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationTensorboardCreateTensorboardOperationMetadata

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]";
Tensorboard tensorboard = new Tensorboard();
// Make the request
Operation<Tensorboard, CreateTensorboardOperationMetadata> response = await tensorboardServiceClient.CreateTensorboardAsync(parent, tensorboard);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, CreateTensorboardOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, CreateTensorboardOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceCreateTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

CreateTensorboardExperiment(CreateTensorboardExperimentRequest, CallSettings)

public virtual TensorboardExperiment CreateTensorboardExperiment(CreateTensorboardExperimentRequest request, CallSettings callSettings = null)

Creates a TensorboardExperiment.

Parameters
NameDescription
requestCreateTensorboardExperimentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardExperiment

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
CreateTensorboardExperimentRequest request = new CreateTensorboardExperimentRequest
{
    ParentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    TensorboardExperiment = new TensorboardExperiment(),
    TensorboardExperimentId = "",
};
// Make the request
TensorboardExperiment response = tensorboardServiceClient.CreateTensorboardExperiment(request);

CreateTensorboardExperiment(TensorboardExperimentName, TensorboardExperiment, string, CallSettings)

public virtual TensorboardExperiment CreateTensorboardExperiment(TensorboardExperimentName parent, TensorboardExperiment tensorboardExperiment, string tensorboardExperimentId, CallSettings callSettings = null)

Creates a TensorboardExperiment.

Parameters
NameDescription
parentTensorboardExperimentName

Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

tensorboardExperimentTensorboardExperiment

The TensorboardExperiment to create.

tensorboardExperimentIdstring

Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardExperiment

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardExperimentName parent = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
TensorboardExperiment tensorboardExperiment = new TensorboardExperiment();
string tensorboardExperimentId = "";
// Make the request
TensorboardExperiment response = tensorboardServiceClient.CreateTensorboardExperiment(parent, tensorboardExperiment, tensorboardExperimentId);

CreateTensorboardExperiment(string, TensorboardExperiment, string, CallSettings)

public virtual TensorboardExperiment CreateTensorboardExperiment(string parent, TensorboardExperiment tensorboardExperiment, string tensorboardExperimentId, CallSettings callSettings = null)

Creates a TensorboardExperiment.

Parameters
NameDescription
parentstring

Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

tensorboardExperimentTensorboardExperiment

The TensorboardExperiment to create.

tensorboardExperimentIdstring

Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardExperiment

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
TensorboardExperiment tensorboardExperiment = new TensorboardExperiment();
string tensorboardExperimentId = "";
// Make the request
TensorboardExperiment response = tensorboardServiceClient.CreateTensorboardExperiment(parent, tensorboardExperiment, tensorboardExperimentId);

CreateTensorboardExperimentAsync(CreateTensorboardExperimentRequest, CallSettings)

public virtual Task<TensorboardExperiment> CreateTensorboardExperimentAsync(CreateTensorboardExperimentRequest request, CallSettings callSettings = null)

Creates a TensorboardExperiment.

Parameters
NameDescription
requestCreateTensorboardExperimentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardExperiment

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTensorboardExperimentRequest request = new CreateTensorboardExperimentRequest
{
    ParentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    TensorboardExperiment = new TensorboardExperiment(),
    TensorboardExperimentId = "",
};
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.CreateTensorboardExperimentAsync(request);

CreateTensorboardExperimentAsync(CreateTensorboardExperimentRequest, CancellationToken)

public virtual Task<TensorboardExperiment> CreateTensorboardExperimentAsync(CreateTensorboardExperimentRequest request, CancellationToken cancellationToken)

Creates a TensorboardExperiment.

Parameters
NameDescription
requestCreateTensorboardExperimentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardExperiment

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTensorboardExperimentRequest request = new CreateTensorboardExperimentRequest
{
    ParentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    TensorboardExperiment = new TensorboardExperiment(),
    TensorboardExperimentId = "",
};
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.CreateTensorboardExperimentAsync(request);

CreateTensorboardExperimentAsync(TensorboardExperimentName, TensorboardExperiment, string, CallSettings)

public virtual Task<TensorboardExperiment> CreateTensorboardExperimentAsync(TensorboardExperimentName parent, TensorboardExperiment tensorboardExperiment, string tensorboardExperimentId, CallSettings callSettings = null)

Creates a TensorboardExperiment.

Parameters
NameDescription
parentTensorboardExperimentName

Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

tensorboardExperimentTensorboardExperiment

The TensorboardExperiment to create.

tensorboardExperimentIdstring

Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardExperiment

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]");
TensorboardExperiment tensorboardExperiment = new TensorboardExperiment();
string tensorboardExperimentId = "";
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.CreateTensorboardExperimentAsync(parent, tensorboardExperiment, tensorboardExperimentId);

CreateTensorboardExperimentAsync(TensorboardExperimentName, TensorboardExperiment, string, CancellationToken)

public virtual Task<TensorboardExperiment> CreateTensorboardExperimentAsync(TensorboardExperimentName parent, TensorboardExperiment tensorboardExperiment, string tensorboardExperimentId, CancellationToken cancellationToken)

Creates a TensorboardExperiment.

Parameters
NameDescription
parentTensorboardExperimentName

Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

tensorboardExperimentTensorboardExperiment

The TensorboardExperiment to create.

tensorboardExperimentIdstring

Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardExperiment

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]");
TensorboardExperiment tensorboardExperiment = new TensorboardExperiment();
string tensorboardExperimentId = "";
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.CreateTensorboardExperimentAsync(parent, tensorboardExperiment, tensorboardExperimentId);

CreateTensorboardExperimentAsync(string, TensorboardExperiment, string, CallSettings)

public virtual Task<TensorboardExperiment> CreateTensorboardExperimentAsync(string parent, TensorboardExperiment tensorboardExperiment, string tensorboardExperimentId, CallSettings callSettings = null)

Creates a TensorboardExperiment.

Parameters
NameDescription
parentstring

Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

tensorboardExperimentTensorboardExperiment

The TensorboardExperiment to create.

tensorboardExperimentIdstring

Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardExperiment

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]";
TensorboardExperiment tensorboardExperiment = new TensorboardExperiment();
string tensorboardExperimentId = "";
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.CreateTensorboardExperimentAsync(parent, tensorboardExperiment, tensorboardExperimentId);

CreateTensorboardExperimentAsync(string, TensorboardExperiment, string, CancellationToken)

public virtual Task<TensorboardExperiment> CreateTensorboardExperimentAsync(string parent, TensorboardExperiment tensorboardExperiment, string tensorboardExperimentId, CancellationToken cancellationToken)

Creates a TensorboardExperiment.

Parameters
NameDescription
parentstring

Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

tensorboardExperimentTensorboardExperiment

The TensorboardExperiment to create.

tensorboardExperimentIdstring

Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardExperiment

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]";
TensorboardExperiment tensorboardExperiment = new TensorboardExperiment();
string tensorboardExperimentId = "";
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.CreateTensorboardExperimentAsync(parent, tensorboardExperiment, tensorboardExperimentId);

CreateTensorboardRun(CreateTensorboardRunRequest, CallSettings)

public virtual TensorboardRun CreateTensorboardRun(CreateTensorboardRunRequest request, CallSettings callSettings = null)

Creates a TensorboardRun.

Parameters
NameDescription
requestCreateTensorboardRunRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardRun

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
CreateTensorboardRunRequest request = new CreateTensorboardRunRequest
{
    ParentAsTensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
    TensorboardRun = new TensorboardRun(),
    TensorboardRunId = "",
};
// Make the request
TensorboardRun response = tensorboardServiceClient.CreateTensorboardRun(request);

CreateTensorboardRun(TensorboardRunName, TensorboardRun, string, CallSettings)

public virtual TensorboardRun CreateTensorboardRun(TensorboardRunName parent, TensorboardRun tensorboardRun, string tensorboardRunId, CallSettings callSettings = null)

Creates a TensorboardRun.

Parameters
NameDescription
parentTensorboardRunName

Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

tensorboardRunTensorboardRun

Required. The TensorboardRun to create.

tensorboardRunIdstring

Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardRun

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardRunName parent = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
TensorboardRun tensorboardRun = new TensorboardRun();
string tensorboardRunId = "";
// Make the request
TensorboardRun response = tensorboardServiceClient.CreateTensorboardRun(parent, tensorboardRun, tensorboardRunId);

CreateTensorboardRun(string, TensorboardRun, string, CallSettings)

public virtual TensorboardRun CreateTensorboardRun(string parent, TensorboardRun tensorboardRun, string tensorboardRunId, CallSettings callSettings = null)

Creates a TensorboardRun.

Parameters
NameDescription
parentstring

Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

tensorboardRunTensorboardRun

Required. The TensorboardRun to create.

tensorboardRunIdstring

Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardRun

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]";
TensorboardRun tensorboardRun = new TensorboardRun();
string tensorboardRunId = "";
// Make the request
TensorboardRun response = tensorboardServiceClient.CreateTensorboardRun(parent, tensorboardRun, tensorboardRunId);

CreateTensorboardRunAsync(CreateTensorboardRunRequest, CallSettings)

public virtual Task<TensorboardRun> CreateTensorboardRunAsync(CreateTensorboardRunRequest request, CallSettings callSettings = null)

Creates a TensorboardRun.

Parameters
NameDescription
requestCreateTensorboardRunRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTensorboardRunRequest request = new CreateTensorboardRunRequest
{
    ParentAsTensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
    TensorboardRun = new TensorboardRun(),
    TensorboardRunId = "",
};
// Make the request
TensorboardRun response = await tensorboardServiceClient.CreateTensorboardRunAsync(request);

CreateTensorboardRunAsync(CreateTensorboardRunRequest, CancellationToken)

public virtual Task<TensorboardRun> CreateTensorboardRunAsync(CreateTensorboardRunRequest request, CancellationToken cancellationToken)

Creates a TensorboardRun.

Parameters
NameDescription
requestCreateTensorboardRunRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTensorboardRunRequest request = new CreateTensorboardRunRequest
{
    ParentAsTensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
    TensorboardRun = new TensorboardRun(),
    TensorboardRunId = "",
};
// Make the request
TensorboardRun response = await tensorboardServiceClient.CreateTensorboardRunAsync(request);

CreateTensorboardRunAsync(TensorboardRunName, TensorboardRun, string, CallSettings)

public virtual Task<TensorboardRun> CreateTensorboardRunAsync(TensorboardRunName parent, TensorboardRun tensorboardRun, string tensorboardRunId, CallSettings callSettings = null)

Creates a TensorboardRun.

Parameters
NameDescription
parentTensorboardRunName

Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

tensorboardRunTensorboardRun

Required. The TensorboardRun to create.

tensorboardRunIdstring

Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardRunName parent = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
TensorboardRun tensorboardRun = new TensorboardRun();
string tensorboardRunId = "";
// Make the request
TensorboardRun response = await tensorboardServiceClient.CreateTensorboardRunAsync(parent, tensorboardRun, tensorboardRunId);

CreateTensorboardRunAsync(TensorboardRunName, TensorboardRun, string, CancellationToken)

public virtual Task<TensorboardRun> CreateTensorboardRunAsync(TensorboardRunName parent, TensorboardRun tensorboardRun, string tensorboardRunId, CancellationToken cancellationToken)

Creates a TensorboardRun.

Parameters
NameDescription
parentTensorboardRunName

Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

tensorboardRunTensorboardRun

Required. The TensorboardRun to create.

tensorboardRunIdstring

Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardRunName parent = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
TensorboardRun tensorboardRun = new TensorboardRun();
string tensorboardRunId = "";
// Make the request
TensorboardRun response = await tensorboardServiceClient.CreateTensorboardRunAsync(parent, tensorboardRun, tensorboardRunId);

CreateTensorboardRunAsync(string, TensorboardRun, string, CallSettings)

public virtual Task<TensorboardRun> CreateTensorboardRunAsync(string parent, TensorboardRun tensorboardRun, string tensorboardRunId, CallSettings callSettings = null)

Creates a TensorboardRun.

Parameters
NameDescription
parentstring

Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

tensorboardRunTensorboardRun

Required. The TensorboardRun to create.

tensorboardRunIdstring

Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardRun

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]/runs/[RUN]";
TensorboardRun tensorboardRun = new TensorboardRun();
string tensorboardRunId = "";
// Make the request
TensorboardRun response = await tensorboardServiceClient.CreateTensorboardRunAsync(parent, tensorboardRun, tensorboardRunId);

CreateTensorboardRunAsync(string, TensorboardRun, string, CancellationToken)

public virtual Task<TensorboardRun> CreateTensorboardRunAsync(string parent, TensorboardRun tensorboardRun, string tensorboardRunId, CancellationToken cancellationToken)

Creates a TensorboardRun.

Parameters
NameDescription
parentstring

Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

tensorboardRunTensorboardRun

Required. The TensorboardRun to create.

tensorboardRunIdstring

Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardRun

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]/runs/[RUN]";
TensorboardRun tensorboardRun = new TensorboardRun();
string tensorboardRunId = "";
// Make the request
TensorboardRun response = await tensorboardServiceClient.CreateTensorboardRunAsync(parent, tensorboardRun, tensorboardRunId);

CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest, CallSettings)

public virtual TensorboardTimeSeries CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Creates a TensorboardTimeSeries.

Parameters
NameDescription
requestCreateTensorboardTimeSeriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardTimeSeries

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
CreateTensorboardTimeSeriesRequest request = new CreateTensorboardTimeSeriesRequest
{
    ParentAsTensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
    TensorboardTimeSeries = new TensorboardTimeSeries(),
    TensorboardTimeSeriesId = "",
};
// Make the request
TensorboardTimeSeries response = tensorboardServiceClient.CreateTensorboardTimeSeries(request);

CreateTensorboardTimeSeries(TensorboardTimeSeriesName, TensorboardTimeSeries, CallSettings)

public virtual TensorboardTimeSeries CreateTensorboardTimeSeries(TensorboardTimeSeriesName parent, TensorboardTimeSeries tensorboardTimeSeries, CallSettings callSettings = null)

Creates a TensorboardTimeSeries.

Parameters
NameDescription
parentTensorboardTimeSeriesName

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

tensorboardTimeSeriesTensorboardTimeSeries

Required. The TensorboardTimeSeries to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardTimeSeries

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardTimeSeriesName parent = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
TensorboardTimeSeries tensorboardTimeSeries = new TensorboardTimeSeries();
// Make the request
TensorboardTimeSeries response = tensorboardServiceClient.CreateTensorboardTimeSeries(parent, tensorboardTimeSeries);

CreateTensorboardTimeSeries(string, TensorboardTimeSeries, CallSettings)

public virtual TensorboardTimeSeries CreateTensorboardTimeSeries(string parent, TensorboardTimeSeries tensorboardTimeSeries, CallSettings callSettings = null)

Creates a TensorboardTimeSeries.

Parameters
NameDescription
parentstring

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

tensorboardTimeSeriesTensorboardTimeSeries

Required. The TensorboardTimeSeries to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardTimeSeries

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]/timeSeries/[TIME_SERIES]";
TensorboardTimeSeries tensorboardTimeSeries = new TensorboardTimeSeries();
// Make the request
TensorboardTimeSeries response = tensorboardServiceClient.CreateTensorboardTimeSeries(parent, tensorboardTimeSeries);

CreateTensorboardTimeSeriesAsync(CreateTensorboardTimeSeriesRequest, CallSettings)

public virtual Task<TensorboardTimeSeries> CreateTensorboardTimeSeriesAsync(CreateTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Creates a TensorboardTimeSeries.

Parameters
NameDescription
requestCreateTensorboardTimeSeriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTensorboardTimeSeriesRequest request = new CreateTensorboardTimeSeriesRequest
{
    ParentAsTensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
    TensorboardTimeSeries = new TensorboardTimeSeries(),
    TensorboardTimeSeriesId = "",
};
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.CreateTensorboardTimeSeriesAsync(request);

CreateTensorboardTimeSeriesAsync(CreateTensorboardTimeSeriesRequest, CancellationToken)

public virtual Task<TensorboardTimeSeries> CreateTensorboardTimeSeriesAsync(CreateTensorboardTimeSeriesRequest request, CancellationToken cancellationToken)

Creates a TensorboardTimeSeries.

Parameters
NameDescription
requestCreateTensorboardTimeSeriesRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTensorboardTimeSeriesRequest request = new CreateTensorboardTimeSeriesRequest
{
    ParentAsTensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
    TensorboardTimeSeries = new TensorboardTimeSeries(),
    TensorboardTimeSeriesId = "",
};
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.CreateTensorboardTimeSeriesAsync(request);

CreateTensorboardTimeSeriesAsync(TensorboardTimeSeriesName, TensorboardTimeSeries, CallSettings)

public virtual Task<TensorboardTimeSeries> CreateTensorboardTimeSeriesAsync(TensorboardTimeSeriesName parent, TensorboardTimeSeries tensorboardTimeSeries, CallSettings callSettings = null)

Creates a TensorboardTimeSeries.

Parameters
NameDescription
parentTensorboardTimeSeriesName

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

tensorboardTimeSeriesTensorboardTimeSeries

Required. The TensorboardTimeSeries to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardTimeSeriesName parent = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
TensorboardTimeSeries tensorboardTimeSeries = new TensorboardTimeSeries();
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.CreateTensorboardTimeSeriesAsync(parent, tensorboardTimeSeries);

CreateTensorboardTimeSeriesAsync(TensorboardTimeSeriesName, TensorboardTimeSeries, CancellationToken)

public virtual Task<TensorboardTimeSeries> CreateTensorboardTimeSeriesAsync(TensorboardTimeSeriesName parent, TensorboardTimeSeries tensorboardTimeSeries, CancellationToken cancellationToken)

Creates a TensorboardTimeSeries.

Parameters
NameDescription
parentTensorboardTimeSeriesName

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

tensorboardTimeSeriesTensorboardTimeSeries

Required. The TensorboardTimeSeries to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardTimeSeriesName parent = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
TensorboardTimeSeries tensorboardTimeSeries = new TensorboardTimeSeries();
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.CreateTensorboardTimeSeriesAsync(parent, tensorboardTimeSeries);

CreateTensorboardTimeSeriesAsync(string, TensorboardTimeSeries, CallSettings)

public virtual Task<TensorboardTimeSeries> CreateTensorboardTimeSeriesAsync(string parent, TensorboardTimeSeries tensorboardTimeSeries, CallSettings callSettings = null)

Creates a TensorboardTimeSeries.

Parameters
NameDescription
parentstring

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

tensorboardTimeSeriesTensorboardTimeSeries

Required. The TensorboardTimeSeries to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardTimeSeries

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]/runs/[RUN]/timeSeries/[TIME_SERIES]";
TensorboardTimeSeries tensorboardTimeSeries = new TensorboardTimeSeries();
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.CreateTensorboardTimeSeriesAsync(parent, tensorboardTimeSeries);

CreateTensorboardTimeSeriesAsync(string, TensorboardTimeSeries, CancellationToken)

public virtual Task<TensorboardTimeSeries> CreateTensorboardTimeSeriesAsync(string parent, TensorboardTimeSeries tensorboardTimeSeries, CancellationToken cancellationToken)

Creates a TensorboardTimeSeries.

Parameters
NameDescription
parentstring

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

tensorboardTimeSeriesTensorboardTimeSeries

Required. The TensorboardTimeSeries to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardTimeSeries

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]/runs/[RUN]/timeSeries/[TIME_SERIES]";
TensorboardTimeSeries tensorboardTimeSeries = new TensorboardTimeSeries();
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.CreateTensorboardTimeSeriesAsync(parent, tensorboardTimeSeries);

DeleteTensorboard(DeleteTensorboardRequest, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteTensorboard(DeleteTensorboardRequest request, CallSettings callSettings = null)

Deletes a Tensorboard.

Parameters
NameDescription
requestDeleteTensorboardRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
DeleteTensorboardRequest request = new DeleteTensorboardRequest
{
    TensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = tensorboardServiceClient.DeleteTensorboard(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceDeleteTensorboard(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboard(TensorboardName, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteTensorboard(TensorboardName name, CallSettings callSettings = null)

Deletes a Tensorboard.

Parameters
NameDescription
nameTensorboardName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardName name = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = tensorboardServiceClient.DeleteTensorboard(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceDeleteTensorboard(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboard(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteTensorboard(string name, CallSettings callSettings = null)

Deletes a Tensorboard.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = tensorboardServiceClient.DeleteTensorboard(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceDeleteTensorboard(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardAsync(DeleteTensorboardRequest, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardAsync(DeleteTensorboardRequest request, CallSettings callSettings = null)

Deletes a Tensorboard.

Parameters
NameDescription
requestDeleteTensorboardRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTensorboardRequest request = new DeleteTensorboardRequest
{
    TensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardAsync(DeleteTensorboardRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardAsync(DeleteTensorboardRequest request, CancellationToken cancellationToken)

Deletes a Tensorboard.

Parameters
NameDescription
requestDeleteTensorboardRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTensorboardRequest request = new DeleteTensorboardRequest
{
    TensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardAsync(TensorboardName, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardAsync(TensorboardName name, CallSettings callSettings = null)

Deletes a Tensorboard.

Parameters
NameDescription
nameTensorboardName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardName name = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardAsync(TensorboardName, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardAsync(TensorboardName name, CancellationToken cancellationToken)

Deletes a Tensorboard.

Parameters
NameDescription
nameTensorboardName

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardName name = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardAsync(string name, CallSettings callSettings = null)

Deletes a Tensorboard.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardAsync(string name, CancellationToken cancellationToken)

Deletes a Tensorboard.

Parameters
NameDescription
namestring

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest request, CallSettings callSettings = null)

Deletes a TensorboardExperiment.

Parameters
NameDescription
requestDeleteTensorboardExperimentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
DeleteTensorboardExperimentRequest request = new DeleteTensorboardExperimentRequest
{
    TensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = tensorboardServiceClient.DeleteTensorboardExperiment(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceDeleteTensorboardExperiment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardExperiment(TensorboardExperimentName, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteTensorboardExperiment(TensorboardExperimentName name, CallSettings callSettings = null)

Deletes a TensorboardExperiment.

Parameters
NameDescription
nameTensorboardExperimentName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardExperimentName name = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = tensorboardServiceClient.DeleteTensorboardExperiment(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceDeleteTensorboardExperiment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardExperiment(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteTensorboardExperiment(string name, CallSettings callSettings = null)

Deletes a TensorboardExperiment.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = tensorboardServiceClient.DeleteTensorboardExperiment(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceDeleteTensorboardExperiment(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardExperimentAsync(DeleteTensorboardExperimentRequest, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardExperimentAsync(DeleteTensorboardExperimentRequest request, CallSettings callSettings = null)

Deletes a TensorboardExperiment.

Parameters
NameDescription
requestDeleteTensorboardExperimentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTensorboardExperimentRequest request = new DeleteTensorboardExperimentRequest
{
    TensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardExperimentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardExperimentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardExperimentAsync(DeleteTensorboardExperimentRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardExperimentAsync(DeleteTensorboardExperimentRequest request, CancellationToken cancellationToken)

Deletes a TensorboardExperiment.

Parameters
NameDescription
requestDeleteTensorboardExperimentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTensorboardExperimentRequest request = new DeleteTensorboardExperimentRequest
{
    TensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardExperimentAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardExperimentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardExperimentAsync(TensorboardExperimentName, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardExperimentAsync(TensorboardExperimentName name, CallSettings callSettings = null)

Deletes a TensorboardExperiment.

Parameters
NameDescription
nameTensorboardExperimentName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardExperimentName name = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardExperimentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardExperimentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardExperimentAsync(TensorboardExperimentName, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardExperimentAsync(TensorboardExperimentName name, CancellationToken cancellationToken)

Deletes a TensorboardExperiment.

Parameters
NameDescription
nameTensorboardExperimentName

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardExperimentName name = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardExperimentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardExperimentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardExperimentAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardExperimentAsync(string name, CallSettings callSettings = null)

Deletes a TensorboardExperiment.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardExperimentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardExperimentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardExperimentAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardExperimentAsync(string name, CancellationToken cancellationToken)

Deletes a TensorboardExperiment.

Parameters
NameDescription
namestring

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardExperimentAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardExperimentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardRun(DeleteTensorboardRunRequest, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteTensorboardRun(DeleteTensorboardRunRequest request, CallSettings callSettings = null)

Deletes a TensorboardRun.

Parameters
NameDescription
requestDeleteTensorboardRunRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
DeleteTensorboardRunRequest request = new DeleteTensorboardRunRequest
{
    TensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = tensorboardServiceClient.DeleteTensorboardRun(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceDeleteTensorboardRun(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardRun(TensorboardRunName, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteTensorboardRun(TensorboardRunName name, CallSettings callSettings = null)

Deletes a TensorboardRun.

Parameters
NameDescription
nameTensorboardRunName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardRunName name = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = tensorboardServiceClient.DeleteTensorboardRun(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceDeleteTensorboardRun(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardRun(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteTensorboardRun(string name, CallSettings callSettings = null)

Deletes a TensorboardRun.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = tensorboardServiceClient.DeleteTensorboardRun(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceDeleteTensorboardRun(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardRunAsync(DeleteTensorboardRunRequest, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardRunAsync(DeleteTensorboardRunRequest request, CallSettings callSettings = null)

Deletes a TensorboardRun.

Parameters
NameDescription
requestDeleteTensorboardRunRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTensorboardRunRequest request = new DeleteTensorboardRunRequest
{
    TensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardRunAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardRunAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardRunAsync(DeleteTensorboardRunRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardRunAsync(DeleteTensorboardRunRequest request, CancellationToken cancellationToken)

Deletes a TensorboardRun.

Parameters
NameDescription
requestDeleteTensorboardRunRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTensorboardRunRequest request = new DeleteTensorboardRunRequest
{
    TensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardRunAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardRunAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardRunAsync(TensorboardRunName, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardRunAsync(TensorboardRunName name, CallSettings callSettings = null)

Deletes a TensorboardRun.

Parameters
NameDescription
nameTensorboardRunName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardRunName name = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardRunAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardRunAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardRunAsync(TensorboardRunName, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardRunAsync(TensorboardRunName name, CancellationToken cancellationToken)

Deletes a TensorboardRun.

Parameters
NameDescription
nameTensorboardRunName

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardRunName name = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardRunAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardRunAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardRunAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardRunAsync(string name, CallSettings callSettings = null)

Deletes a TensorboardRun.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardRunAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardRunAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardRunAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardRunAsync(string name, CancellationToken cancellationToken)

Deletes a TensorboardRun.

Parameters
NameDescription
namestring

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardRunAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardRunAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Deletes a TensorboardTimeSeries.

Parameters
NameDescription
requestDeleteTensorboardTimeSeriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
DeleteTensorboardTimeSeriesRequest request = new DeleteTensorboardTimeSeriesRequest
{
    TensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = tensorboardServiceClient.DeleteTensorboardTimeSeries(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceDeleteTensorboardTimeSeries(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardTimeSeries(TensorboardTimeSeriesName, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteTensorboardTimeSeries(TensorboardTimeSeriesName name, CallSettings callSettings = null)

Deletes a TensorboardTimeSeries.

Parameters
NameDescription
nameTensorboardTimeSeriesName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardTimeSeriesName name = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = tensorboardServiceClient.DeleteTensorboardTimeSeries(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceDeleteTensorboardTimeSeries(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardTimeSeries(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> DeleteTensorboardTimeSeries(string name, CallSettings callSettings = null)

Deletes a TensorboardTimeSeries.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]/timeSeries/[TIME_SERIES]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = tensorboardServiceClient.DeleteTensorboardTimeSeries(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceDeleteTensorboardTimeSeries(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardTimeSeriesAsync(DeleteTensorboardTimeSeriesRequest, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardTimeSeriesAsync(DeleteTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Deletes a TensorboardTimeSeries.

Parameters
NameDescription
requestDeleteTensorboardTimeSeriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTensorboardTimeSeriesRequest request = new DeleteTensorboardTimeSeriesRequest
{
    TensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardTimeSeriesAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardTimeSeriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardTimeSeriesAsync(DeleteTensorboardTimeSeriesRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardTimeSeriesAsync(DeleteTensorboardTimeSeriesRequest request, CancellationToken cancellationToken)

Deletes a TensorboardTimeSeries.

Parameters
NameDescription
requestDeleteTensorboardTimeSeriesRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTensorboardTimeSeriesRequest request = new DeleteTensorboardTimeSeriesRequest
{
    TensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
};
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardTimeSeriesAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardTimeSeriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardTimeSeriesAsync(TensorboardTimeSeriesName, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardTimeSeriesAsync(TensorboardTimeSeriesName name, CallSettings callSettings = null)

Deletes a TensorboardTimeSeries.

Parameters
NameDescription
nameTensorboardTimeSeriesName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardTimeSeriesName name = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardTimeSeriesAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardTimeSeriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardTimeSeriesAsync(TensorboardTimeSeriesName, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardTimeSeriesAsync(TensorboardTimeSeriesName name, CancellationToken cancellationToken)

Deletes a TensorboardTimeSeries.

Parameters
NameDescription
nameTensorboardTimeSeriesName

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardTimeSeriesName name = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardTimeSeriesAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardTimeSeriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardTimeSeriesAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardTimeSeriesAsync(string name, CallSettings callSettings = null)

Deletes a TensorboardTimeSeries.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]/timeSeries/[TIME_SERIES]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardTimeSeriesAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardTimeSeriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteTensorboardTimeSeriesAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> DeleteTensorboardTimeSeriesAsync(string name, CancellationToken cancellationToken)

Deletes a TensorboardTimeSeries.

Parameters
NameDescription
namestring

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]/timeSeries/[TIME_SERIES]";
// Make the request
Operation<Empty, DeleteOperationMetadata> response = await tensorboardServiceClient.DeleteTensorboardTimeSeriesAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceDeleteTensorboardTimeSeriesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

ExportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest, CallSettings)

public virtual PagedEnumerable<ExportTensorboardTimeSeriesDataResponse, TimeSeriesDataPoint> ExportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestExportTensorboardTimeSeriesDataRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableExportTensorboardTimeSeriesDataResponseTimeSeriesDataPoint

A pageable sequence of TimeSeriesDataPoint resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
ExportTensorboardTimeSeriesDataRequest request = new ExportTensorboardTimeSeriesDataRequest
{
    TensorboardTimeSeriesAsTensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ExportTensorboardTimeSeriesDataResponse, TimeSeriesDataPoint> response = tensorboardServiceClient.ExportTensorboardTimeSeriesData(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (TimeSeriesDataPoint item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ExportTensorboardTimeSeriesDataResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TimeSeriesDataPoint item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TimeSeriesDataPoint> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TimeSeriesDataPoint item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ExportTensorboardTimeSeriesData(TensorboardTimeSeriesName, string, int?, CallSettings)

public virtual PagedEnumerable<ExportTensorboardTimeSeriesDataResponse, TimeSeriesDataPoint> ExportTensorboardTimeSeriesData(TensorboardTimeSeriesName tensorboardTimeSeries, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardTimeSeriesTensorboardTimeSeriesName

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}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableExportTensorboardTimeSeriesDataResponseTimeSeriesDataPoint

A pageable sequence of TimeSeriesDataPoint resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardTimeSeriesName tensorboardTimeSeries = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
// Make the request
PagedEnumerable<ExportTensorboardTimeSeriesDataResponse, TimeSeriesDataPoint> response = tensorboardServiceClient.ExportTensorboardTimeSeriesData(tensorboardTimeSeries);

// Iterate over all response items, lazily performing RPCs as required
foreach (TimeSeriesDataPoint item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ExportTensorboardTimeSeriesDataResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TimeSeriesDataPoint item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TimeSeriesDataPoint> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TimeSeriesDataPoint item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ExportTensorboardTimeSeriesData(string, string, int?, CallSettings)

public virtual PagedEnumerable<ExportTensorboardTimeSeriesDataResponse, TimeSeriesDataPoint> ExportTensorboardTimeSeriesData(string tensorboardTimeSeries, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardTimeSeriesstring

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}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableExportTensorboardTimeSeriesDataResponseTimeSeriesDataPoint

A pageable sequence of TimeSeriesDataPoint resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string tensorboardTimeSeries = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]/timeSeries/[TIME_SERIES]";
// Make the request
PagedEnumerable<ExportTensorboardTimeSeriesDataResponse, TimeSeriesDataPoint> response = tensorboardServiceClient.ExportTensorboardTimeSeriesData(tensorboardTimeSeries);

// Iterate over all response items, lazily performing RPCs as required
foreach (TimeSeriesDataPoint item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ExportTensorboardTimeSeriesDataResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TimeSeriesDataPoint item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TimeSeriesDataPoint> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TimeSeriesDataPoint item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ExportTensorboardTimeSeriesDataAsync(ExportTensorboardTimeSeriesDataRequest, CallSettings)

public virtual PagedAsyncEnumerable<ExportTensorboardTimeSeriesDataResponse, TimeSeriesDataPoint> ExportTensorboardTimeSeriesDataAsync(ExportTensorboardTimeSeriesDataRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestExportTensorboardTimeSeriesDataRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableExportTensorboardTimeSeriesDataResponseTimeSeriesDataPoint

A pageable asynchronous sequence of TimeSeriesDataPoint resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
ExportTensorboardTimeSeriesDataRequest request = new ExportTensorboardTimeSeriesDataRequest
{
    TensorboardTimeSeriesAsTensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ExportTensorboardTimeSeriesDataResponse, TimeSeriesDataPoint> response = tensorboardServiceClient.ExportTensorboardTimeSeriesDataAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TimeSeriesDataPoint item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ExportTensorboardTimeSeriesDataResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TimeSeriesDataPoint item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TimeSeriesDataPoint> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TimeSeriesDataPoint item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ExportTensorboardTimeSeriesDataAsync(TensorboardTimeSeriesName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ExportTensorboardTimeSeriesDataResponse, TimeSeriesDataPoint> ExportTensorboardTimeSeriesDataAsync(TensorboardTimeSeriesName tensorboardTimeSeries, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardTimeSeriesTensorboardTimeSeriesName

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}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableExportTensorboardTimeSeriesDataResponseTimeSeriesDataPoint

A pageable asynchronous sequence of TimeSeriesDataPoint resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardTimeSeriesName tensorboardTimeSeries = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
// Make the request
PagedAsyncEnumerable<ExportTensorboardTimeSeriesDataResponse, TimeSeriesDataPoint> response = tensorboardServiceClient.ExportTensorboardTimeSeriesDataAsync(tensorboardTimeSeries);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TimeSeriesDataPoint item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ExportTensorboardTimeSeriesDataResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TimeSeriesDataPoint item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TimeSeriesDataPoint> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TimeSeriesDataPoint item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ExportTensorboardTimeSeriesDataAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ExportTensorboardTimeSeriesDataResponse, TimeSeriesDataPoint> ExportTensorboardTimeSeriesDataAsync(string tensorboardTimeSeries, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardTimeSeriesstring

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}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableExportTensorboardTimeSeriesDataResponseTimeSeriesDataPoint

A pageable asynchronous sequence of TimeSeriesDataPoint resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string tensorboardTimeSeries = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]/timeSeries/[TIME_SERIES]";
// Make the request
PagedAsyncEnumerable<ExportTensorboardTimeSeriesDataResponse, TimeSeriesDataPoint> response = tensorboardServiceClient.ExportTensorboardTimeSeriesDataAsync(tensorboardTimeSeries);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TimeSeriesDataPoint item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ExportTensorboardTimeSeriesDataResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TimeSeriesDataPoint item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TimeSeriesDataPoint> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TimeSeriesDataPoint item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

GetTensorboard(GetTensorboardRequest, CallSettings)

public virtual Tensorboard GetTensorboard(GetTensorboardRequest request, CallSettings callSettings = null)

Gets a Tensorboard.

Parameters
NameDescription
requestGetTensorboardRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Tensorboard

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
GetTensorboardRequest request = new GetTensorboardRequest
{
    TensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
};
// Make the request
Tensorboard response = tensorboardServiceClient.GetTensorboard(request);

GetTensorboard(TensorboardName, CallSettings)

public virtual Tensorboard GetTensorboard(TensorboardName name, CallSettings callSettings = null)

Gets a Tensorboard.

Parameters
NameDescription
nameTensorboardName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Tensorboard

The RPC response.

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

GetTensorboard(string, CallSettings)

public virtual Tensorboard GetTensorboard(string name, CallSettings callSettings = null)

Gets a Tensorboard.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Tensorboard

The RPC response.

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

GetTensorboardAsync(GetTensorboardRequest, CallSettings)

public virtual Task<Tensorboard> GetTensorboardAsync(GetTensorboardRequest request, CallSettings callSettings = null)

Gets a Tensorboard.

Parameters
NameDescription
requestGetTensorboardRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboard

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
GetTensorboardRequest request = new GetTensorboardRequest
{
    TensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
};
// Make the request
Tensorboard response = await tensorboardServiceClient.GetTensorboardAsync(request);

GetTensorboardAsync(GetTensorboardRequest, CancellationToken)

public virtual Task<Tensorboard> GetTensorboardAsync(GetTensorboardRequest request, CancellationToken cancellationToken)

Gets a Tensorboard.

Parameters
NameDescription
requestGetTensorboardRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboard

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
GetTensorboardRequest request = new GetTensorboardRequest
{
    TensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
};
// Make the request
Tensorboard response = await tensorboardServiceClient.GetTensorboardAsync(request);

GetTensorboardAsync(TensorboardName, CallSettings)

public virtual Task<Tensorboard> GetTensorboardAsync(TensorboardName name, CallSettings callSettings = null)

Gets a Tensorboard.

Parameters
NameDescription
nameTensorboardName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboard

A Task containing the RPC response.

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

GetTensorboardAsync(TensorboardName, CancellationToken)

public virtual Task<Tensorboard> GetTensorboardAsync(TensorboardName name, CancellationToken cancellationToken)

Gets a Tensorboard.

Parameters
NameDescription
nameTensorboardName

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboard

A Task containing the RPC response.

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

GetTensorboardAsync(string, CallSettings)

public virtual Task<Tensorboard> GetTensorboardAsync(string name, CallSettings callSettings = null)

Gets a Tensorboard.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboard

A Task containing the RPC response.

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

GetTensorboardAsync(string, CancellationToken)

public virtual Task<Tensorboard> GetTensorboardAsync(string name, CancellationToken cancellationToken)

Gets a Tensorboard.

Parameters
NameDescription
namestring

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboard

A Task containing the RPC response.

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

GetTensorboardExperiment(GetTensorboardExperimentRequest, CallSettings)

public virtual TensorboardExperiment GetTensorboardExperiment(GetTensorboardExperimentRequest request, CallSettings callSettings = null)

Gets a TensorboardExperiment.

Parameters
NameDescription
requestGetTensorboardExperimentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardExperiment

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
GetTensorboardExperimentRequest request = new GetTensorboardExperimentRequest
{
    TensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
};
// Make the request
TensorboardExperiment response = tensorboardServiceClient.GetTensorboardExperiment(request);

GetTensorboardExperiment(TensorboardExperimentName, CallSettings)

public virtual TensorboardExperiment GetTensorboardExperiment(TensorboardExperimentName name, CallSettings callSettings = null)

Gets a TensorboardExperiment.

Parameters
NameDescription
nameTensorboardExperimentName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardExperiment

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardExperimentName name = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
// Make the request
TensorboardExperiment response = tensorboardServiceClient.GetTensorboardExperiment(name);

GetTensorboardExperiment(string, CallSettings)

public virtual TensorboardExperiment GetTensorboardExperiment(string name, CallSettings callSettings = null)

Gets a TensorboardExperiment.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardExperiment

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
// Make the request
TensorboardExperiment response = tensorboardServiceClient.GetTensorboardExperiment(name);

GetTensorboardExperimentAsync(GetTensorboardExperimentRequest, CallSettings)

public virtual Task<TensorboardExperiment> GetTensorboardExperimentAsync(GetTensorboardExperimentRequest request, CallSettings callSettings = null)

Gets a TensorboardExperiment.

Parameters
NameDescription
requestGetTensorboardExperimentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardExperiment

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
GetTensorboardExperimentRequest request = new GetTensorboardExperimentRequest
{
    TensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
};
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.GetTensorboardExperimentAsync(request);

GetTensorboardExperimentAsync(GetTensorboardExperimentRequest, CancellationToken)

public virtual Task<TensorboardExperiment> GetTensorboardExperimentAsync(GetTensorboardExperimentRequest request, CancellationToken cancellationToken)

Gets a TensorboardExperiment.

Parameters
NameDescription
requestGetTensorboardExperimentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardExperiment

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
GetTensorboardExperimentRequest request = new GetTensorboardExperimentRequest
{
    TensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
};
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.GetTensorboardExperimentAsync(request);

GetTensorboardExperimentAsync(TensorboardExperimentName, CallSettings)

public virtual Task<TensorboardExperiment> GetTensorboardExperimentAsync(TensorboardExperimentName name, CallSettings callSettings = null)

Gets a TensorboardExperiment.

Parameters
NameDescription
nameTensorboardExperimentName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardExperiment

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardExperimentName name = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.GetTensorboardExperimentAsync(name);

GetTensorboardExperimentAsync(TensorboardExperimentName, CancellationToken)

public virtual Task<TensorboardExperiment> GetTensorboardExperimentAsync(TensorboardExperimentName name, CancellationToken cancellationToken)

Gets a TensorboardExperiment.

Parameters
NameDescription
nameTensorboardExperimentName

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardExperiment

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardExperimentName name = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.GetTensorboardExperimentAsync(name);

GetTensorboardExperimentAsync(string, CallSettings)

public virtual Task<TensorboardExperiment> GetTensorboardExperimentAsync(string name, CallSettings callSettings = null)

Gets a TensorboardExperiment.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardExperiment

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.GetTensorboardExperimentAsync(name);

GetTensorboardExperimentAsync(string, CancellationToken)

public virtual Task<TensorboardExperiment> GetTensorboardExperimentAsync(string name, CancellationToken cancellationToken)

Gets a TensorboardExperiment.

Parameters
NameDescription
namestring

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardExperiment

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.GetTensorboardExperimentAsync(name);

GetTensorboardRun(GetTensorboardRunRequest, CallSettings)

public virtual TensorboardRun GetTensorboardRun(GetTensorboardRunRequest request, CallSettings callSettings = null)

Gets a TensorboardRun.

Parameters
NameDescription
requestGetTensorboardRunRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardRun

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
GetTensorboardRunRequest request = new GetTensorboardRunRequest
{
    TensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
};
// Make the request
TensorboardRun response = tensorboardServiceClient.GetTensorboardRun(request);

GetTensorboardRun(TensorboardRunName, CallSettings)

public virtual TensorboardRun GetTensorboardRun(TensorboardRunName name, CallSettings callSettings = null)

Gets a TensorboardRun.

Parameters
NameDescription
nameTensorboardRunName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardRun

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardRunName name = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
// Make the request
TensorboardRun response = tensorboardServiceClient.GetTensorboardRun(name);

GetTensorboardRun(string, CallSettings)

public virtual TensorboardRun GetTensorboardRun(string name, CallSettings callSettings = null)

Gets a TensorboardRun.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardRun

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]";
// Make the request
TensorboardRun response = tensorboardServiceClient.GetTensorboardRun(name);

GetTensorboardRunAsync(GetTensorboardRunRequest, CallSettings)

public virtual Task<TensorboardRun> GetTensorboardRunAsync(GetTensorboardRunRequest request, CallSettings callSettings = null)

Gets a TensorboardRun.

Parameters
NameDescription
requestGetTensorboardRunRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
GetTensorboardRunRequest request = new GetTensorboardRunRequest
{
    TensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
};
// Make the request
TensorboardRun response = await tensorboardServiceClient.GetTensorboardRunAsync(request);

GetTensorboardRunAsync(GetTensorboardRunRequest, CancellationToken)

public virtual Task<TensorboardRun> GetTensorboardRunAsync(GetTensorboardRunRequest request, CancellationToken cancellationToken)

Gets a TensorboardRun.

Parameters
NameDescription
requestGetTensorboardRunRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
GetTensorboardRunRequest request = new GetTensorboardRunRequest
{
    TensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
};
// Make the request
TensorboardRun response = await tensorboardServiceClient.GetTensorboardRunAsync(request);

GetTensorboardRunAsync(TensorboardRunName, CallSettings)

public virtual Task<TensorboardRun> GetTensorboardRunAsync(TensorboardRunName name, CallSettings callSettings = null)

Gets a TensorboardRun.

Parameters
NameDescription
nameTensorboardRunName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardRunName name = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
// Make the request
TensorboardRun response = await tensorboardServiceClient.GetTensorboardRunAsync(name);

GetTensorboardRunAsync(TensorboardRunName, CancellationToken)

public virtual Task<TensorboardRun> GetTensorboardRunAsync(TensorboardRunName name, CancellationToken cancellationToken)

Gets a TensorboardRun.

Parameters
NameDescription
nameTensorboardRunName

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardRunName name = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
// Make the request
TensorboardRun response = await tensorboardServiceClient.GetTensorboardRunAsync(name);

GetTensorboardRunAsync(string, CallSettings)

public virtual Task<TensorboardRun> GetTensorboardRunAsync(string name, CallSettings callSettings = null)

Gets a TensorboardRun.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]";
// Make the request
TensorboardRun response = await tensorboardServiceClient.GetTensorboardRunAsync(name);

GetTensorboardRunAsync(string, CancellationToken)

public virtual Task<TensorboardRun> GetTensorboardRunAsync(string name, CancellationToken cancellationToken)

Gets a TensorboardRun.

Parameters
NameDescription
namestring

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]";
// Make the request
TensorboardRun response = await tensorboardServiceClient.GetTensorboardRunAsync(name);

GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest, CallSettings)

public virtual TensorboardTimeSeries GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Gets a TensorboardTimeSeries.

Parameters
NameDescription
requestGetTensorboardTimeSeriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardTimeSeries

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
GetTensorboardTimeSeriesRequest request = new GetTensorboardTimeSeriesRequest
{
    TensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
};
// Make the request
TensorboardTimeSeries response = tensorboardServiceClient.GetTensorboardTimeSeries(request);

GetTensorboardTimeSeries(TensorboardTimeSeriesName, CallSettings)

public virtual TensorboardTimeSeries GetTensorboardTimeSeries(TensorboardTimeSeriesName name, CallSettings callSettings = null)

Gets a TensorboardTimeSeries.

Parameters
NameDescription
nameTensorboardTimeSeriesName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardTimeSeries

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardTimeSeriesName name = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
// Make the request
TensorboardTimeSeries response = tensorboardServiceClient.GetTensorboardTimeSeries(name);

GetTensorboardTimeSeries(string, CallSettings)

public virtual TensorboardTimeSeries GetTensorboardTimeSeries(string name, CallSettings callSettings = null)

Gets a TensorboardTimeSeries.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardTimeSeries

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]/timeSeries/[TIME_SERIES]";
// Make the request
TensorboardTimeSeries response = tensorboardServiceClient.GetTensorboardTimeSeries(name);

GetTensorboardTimeSeriesAsync(GetTensorboardTimeSeriesRequest, CallSettings)

public virtual Task<TensorboardTimeSeries> GetTensorboardTimeSeriesAsync(GetTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Gets a TensorboardTimeSeries.

Parameters
NameDescription
requestGetTensorboardTimeSeriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
GetTensorboardTimeSeriesRequest request = new GetTensorboardTimeSeriesRequest
{
    TensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
};
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.GetTensorboardTimeSeriesAsync(request);

GetTensorboardTimeSeriesAsync(GetTensorboardTimeSeriesRequest, CancellationToken)

public virtual Task<TensorboardTimeSeries> GetTensorboardTimeSeriesAsync(GetTensorboardTimeSeriesRequest request, CancellationToken cancellationToken)

Gets a TensorboardTimeSeries.

Parameters
NameDescription
requestGetTensorboardTimeSeriesRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
GetTensorboardTimeSeriesRequest request = new GetTensorboardTimeSeriesRequest
{
    TensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
};
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.GetTensorboardTimeSeriesAsync(request);

GetTensorboardTimeSeriesAsync(TensorboardTimeSeriesName, CallSettings)

public virtual Task<TensorboardTimeSeries> GetTensorboardTimeSeriesAsync(TensorboardTimeSeriesName name, CallSettings callSettings = null)

Gets a TensorboardTimeSeries.

Parameters
NameDescription
nameTensorboardTimeSeriesName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardTimeSeriesName name = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.GetTensorboardTimeSeriesAsync(name);

GetTensorboardTimeSeriesAsync(TensorboardTimeSeriesName, CancellationToken)

public virtual Task<TensorboardTimeSeries> GetTensorboardTimeSeriesAsync(TensorboardTimeSeriesName name, CancellationToken cancellationToken)

Gets a TensorboardTimeSeries.

Parameters
NameDescription
nameTensorboardTimeSeriesName

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardTimeSeriesName name = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.GetTensorboardTimeSeriesAsync(name);

GetTensorboardTimeSeriesAsync(string, CallSettings)

public virtual Task<TensorboardTimeSeries> GetTensorboardTimeSeriesAsync(string name, CallSettings callSettings = null)

Gets a TensorboardTimeSeries.

Parameters
NameDescription
namestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]/timeSeries/[TIME_SERIES]";
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.GetTensorboardTimeSeriesAsync(name);

GetTensorboardTimeSeriesAsync(string, CancellationToken)

public virtual Task<TensorboardTimeSeries> GetTensorboardTimeSeriesAsync(string name, CancellationToken cancellationToken)

Gets a TensorboardTimeSeries.

Parameters
NameDescription
namestring

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]/timeSeries/[TIME_SERIES]";
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.GetTensorboardTimeSeriesAsync(name);

ListTensorboardExperiments(ListTensorboardExperimentsRequest, CallSettings)

public virtual PagedEnumerable<ListTensorboardExperimentsResponse, TensorboardExperiment> ListTensorboardExperiments(ListTensorboardExperimentsRequest request, CallSettings callSettings = null)

Lists TensorboardExperiments in a Location.

Parameters
NameDescription
requestListTensorboardExperimentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTensorboardExperimentsResponseTensorboardExperiment

A pageable sequence of TensorboardExperiment resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
ListTensorboardExperimentsRequest request = new ListTensorboardExperimentsRequest
{
    ParentAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
    Filter = "",
    OrderBy = "",
    ReadMask = new FieldMask(),
};
// Make the request
PagedEnumerable<ListTensorboardExperimentsResponse, TensorboardExperiment> response = tensorboardServiceClient.ListTensorboardExperiments(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (TensorboardExperiment item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTensorboardExperimentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardExperiment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardExperiment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardExperiment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardExperiments(TensorboardName, string, int?, CallSettings)

public virtual PagedEnumerable<ListTensorboardExperimentsResponse, TensorboardExperiment> ListTensorboardExperiments(TensorboardName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists TensorboardExperiments in a Location.

Parameters
NameDescription
parentTensorboardName

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTensorboardExperimentsResponseTensorboardExperiment

A pageable sequence of TensorboardExperiment resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardName parent = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
// Make the request
PagedEnumerable<ListTensorboardExperimentsResponse, TensorboardExperiment> response = tensorboardServiceClient.ListTensorboardExperiments(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TensorboardExperiment item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTensorboardExperimentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardExperiment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardExperiment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardExperiment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardExperiments(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListTensorboardExperimentsResponse, TensorboardExperiment> ListTensorboardExperiments(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists TensorboardExperiments in a Location.

Parameters
NameDescription
parentstring

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTensorboardExperimentsResponseTensorboardExperiment

A pageable sequence of TensorboardExperiment resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]";
// Make the request
PagedEnumerable<ListTensorboardExperimentsResponse, TensorboardExperiment> response = tensorboardServiceClient.ListTensorboardExperiments(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TensorboardExperiment item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTensorboardExperimentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardExperiment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardExperiment> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardExperiment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardExperimentsAsync(ListTensorboardExperimentsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListTensorboardExperimentsResponse, TensorboardExperiment> ListTensorboardExperimentsAsync(ListTensorboardExperimentsRequest request, CallSettings callSettings = null)

Lists TensorboardExperiments in a Location.

Parameters
NameDescription
requestListTensorboardExperimentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTensorboardExperimentsResponseTensorboardExperiment

A pageable asynchronous sequence of TensorboardExperiment resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
ListTensorboardExperimentsRequest request = new ListTensorboardExperimentsRequest
{
    ParentAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
    Filter = "",
    OrderBy = "",
    ReadMask = new FieldMask(),
};
// Make the request
PagedAsyncEnumerable<ListTensorboardExperimentsResponse, TensorboardExperiment> response = tensorboardServiceClient.ListTensorboardExperimentsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TensorboardExperiment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTensorboardExperimentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardExperiment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardExperiment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardExperiment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardExperimentsAsync(TensorboardName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTensorboardExperimentsResponse, TensorboardExperiment> ListTensorboardExperimentsAsync(TensorboardName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists TensorboardExperiments in a Location.

Parameters
NameDescription
parentTensorboardName

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTensorboardExperimentsResponseTensorboardExperiment

A pageable asynchronous sequence of TensorboardExperiment resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardName parent = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
// Make the request
PagedAsyncEnumerable<ListTensorboardExperimentsResponse, TensorboardExperiment> response = tensorboardServiceClient.ListTensorboardExperimentsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TensorboardExperiment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTensorboardExperimentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardExperiment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardExperiment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardExperiment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardExperimentsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTensorboardExperimentsResponse, TensorboardExperiment> ListTensorboardExperimentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists TensorboardExperiments in a Location.

Parameters
NameDescription
parentstring

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTensorboardExperimentsResponseTensorboardExperiment

A pageable asynchronous sequence of TensorboardExperiment resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]";
// Make the request
PagedAsyncEnumerable<ListTensorboardExperimentsResponse, TensorboardExperiment> response = tensorboardServiceClient.ListTensorboardExperimentsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TensorboardExperiment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTensorboardExperimentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardExperiment item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardExperiment> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardExperiment item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardRuns(ListTensorboardRunsRequest, CallSettings)

public virtual PagedEnumerable<ListTensorboardRunsResponse, TensorboardRun> ListTensorboardRuns(ListTensorboardRunsRequest request, CallSettings callSettings = null)

Lists TensorboardRuns in a Location.

Parameters
NameDescription
requestListTensorboardRunsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTensorboardRunsResponseTensorboardRun

A pageable sequence of TensorboardRun resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
ListTensorboardRunsRequest request = new ListTensorboardRunsRequest
{
    ParentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    Filter = "",
    OrderBy = "",
    ReadMask = new FieldMask(),
};
// Make the request
PagedEnumerable<ListTensorboardRunsResponse, TensorboardRun> response = tensorboardServiceClient.ListTensorboardRuns(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (TensorboardRun item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTensorboardRunsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardRun item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardRun> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardRun item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardRuns(TensorboardExperimentName, string, int?, CallSettings)

public virtual PagedEnumerable<ListTensorboardRunsResponse, TensorboardRun> ListTensorboardRuns(TensorboardExperimentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists TensorboardRuns in a Location.

Parameters
NameDescription
parentTensorboardExperimentName

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTensorboardRunsResponseTensorboardRun

A pageable sequence of TensorboardRun resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardExperimentName parent = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
// Make the request
PagedEnumerable<ListTensorboardRunsResponse, TensorboardRun> response = tensorboardServiceClient.ListTensorboardRuns(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TensorboardRun item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTensorboardRunsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardRun item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardRun> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardRun item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardRuns(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListTensorboardRunsResponse, TensorboardRun> ListTensorboardRuns(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists TensorboardRuns in a Location.

Parameters
NameDescription
parentstring

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTensorboardRunsResponseTensorboardRun

A pageable sequence of TensorboardRun resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
// Make the request
PagedEnumerable<ListTensorboardRunsResponse, TensorboardRun> response = tensorboardServiceClient.ListTensorboardRuns(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TensorboardRun item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTensorboardRunsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardRun item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardRun> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardRun item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardRunsAsync(ListTensorboardRunsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListTensorboardRunsResponse, TensorboardRun> ListTensorboardRunsAsync(ListTensorboardRunsRequest request, CallSettings callSettings = null)

Lists TensorboardRuns in a Location.

Parameters
NameDescription
requestListTensorboardRunsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTensorboardRunsResponseTensorboardRun

A pageable asynchronous sequence of TensorboardRun resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
ListTensorboardRunsRequest request = new ListTensorboardRunsRequest
{
    ParentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    Filter = "",
    OrderBy = "",
    ReadMask = new FieldMask(),
};
// Make the request
PagedAsyncEnumerable<ListTensorboardRunsResponse, TensorboardRun> response = tensorboardServiceClient.ListTensorboardRunsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TensorboardRun item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTensorboardRunsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardRun item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardRun> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardRun item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardRunsAsync(TensorboardExperimentName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTensorboardRunsResponse, TensorboardRun> ListTensorboardRunsAsync(TensorboardExperimentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists TensorboardRuns in a Location.

Parameters
NameDescription
parentTensorboardExperimentName

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTensorboardRunsResponseTensorboardRun

A pageable asynchronous sequence of TensorboardRun resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardExperimentName parent = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
// Make the request
PagedAsyncEnumerable<ListTensorboardRunsResponse, TensorboardRun> response = tensorboardServiceClient.ListTensorboardRunsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TensorboardRun item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTensorboardRunsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardRun item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardRun> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardRun item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardRunsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTensorboardRunsResponse, TensorboardRun> ListTensorboardRunsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists TensorboardRuns in a Location.

Parameters
NameDescription
parentstring

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTensorboardRunsResponseTensorboardRun

A pageable asynchronous sequence of TensorboardRun resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
// Make the request
PagedAsyncEnumerable<ListTensorboardRunsResponse, TensorboardRun> response = tensorboardServiceClient.ListTensorboardRunsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TensorboardRun item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTensorboardRunsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardRun item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardRun> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardRun item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest, CallSettings)

public virtual PagedEnumerable<ListTensorboardTimeSeriesResponse, TensorboardTimeSeries> ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Lists TensorboardTimeSeries in a Location.

Parameters
NameDescription
requestListTensorboardTimeSeriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTensorboardTimeSeriesResponseTensorboardTimeSeries

A pageable sequence of TensorboardTimeSeries resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
ListTensorboardTimeSeriesRequest request = new ListTensorboardTimeSeriesRequest
{
    ParentAsTensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
    Filter = "",
    OrderBy = "",
    ReadMask = new FieldMask(),
};
// Make the request
PagedEnumerable<ListTensorboardTimeSeriesResponse, TensorboardTimeSeries> response = tensorboardServiceClient.ListTensorboardTimeSeries(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (TensorboardTimeSeries item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTensorboardTimeSeriesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardTimeSeries item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardTimeSeries> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardTimeSeries item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardTimeSeries(TensorboardRunName, string, int?, CallSettings)

public virtual PagedEnumerable<ListTensorboardTimeSeriesResponse, TensorboardTimeSeries> ListTensorboardTimeSeries(TensorboardRunName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists TensorboardTimeSeries in a Location.

Parameters
NameDescription
parentTensorboardRunName

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTensorboardTimeSeriesResponseTensorboardTimeSeries

A pageable sequence of TensorboardTimeSeries resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardRunName parent = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
// Make the request
PagedEnumerable<ListTensorboardTimeSeriesResponse, TensorboardTimeSeries> response = tensorboardServiceClient.ListTensorboardTimeSeries(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TensorboardTimeSeries item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTensorboardTimeSeriesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardTimeSeries item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardTimeSeries> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardTimeSeries item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardTimeSeries(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListTensorboardTimeSeriesResponse, TensorboardTimeSeries> ListTensorboardTimeSeries(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists TensorboardTimeSeries in a Location.

Parameters
NameDescription
parentstring

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTensorboardTimeSeriesResponseTensorboardTimeSeries

A pageable sequence of TensorboardTimeSeries resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]";
// Make the request
PagedEnumerable<ListTensorboardTimeSeriesResponse, TensorboardTimeSeries> response = tensorboardServiceClient.ListTensorboardTimeSeries(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TensorboardTimeSeries item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTensorboardTimeSeriesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardTimeSeries item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardTimeSeries> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardTimeSeries item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardTimeSeriesAsync(ListTensorboardTimeSeriesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListTensorboardTimeSeriesResponse, TensorboardTimeSeries> ListTensorboardTimeSeriesAsync(ListTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Lists TensorboardTimeSeries in a Location.

Parameters
NameDescription
requestListTensorboardTimeSeriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTensorboardTimeSeriesResponseTensorboardTimeSeries

A pageable asynchronous sequence of TensorboardTimeSeries resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
ListTensorboardTimeSeriesRequest request = new ListTensorboardTimeSeriesRequest
{
    ParentAsTensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
    Filter = "",
    OrderBy = "",
    ReadMask = new FieldMask(),
};
// Make the request
PagedAsyncEnumerable<ListTensorboardTimeSeriesResponse, TensorboardTimeSeries> response = tensorboardServiceClient.ListTensorboardTimeSeriesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TensorboardTimeSeries item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTensorboardTimeSeriesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardTimeSeries item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardTimeSeries> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardTimeSeries item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardTimeSeriesAsync(TensorboardRunName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTensorboardTimeSeriesResponse, TensorboardTimeSeries> ListTensorboardTimeSeriesAsync(TensorboardRunName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists TensorboardTimeSeries in a Location.

Parameters
NameDescription
parentTensorboardRunName

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTensorboardTimeSeriesResponseTensorboardTimeSeries

A pageable asynchronous sequence of TensorboardTimeSeries resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardRunName parent = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
// Make the request
PagedAsyncEnumerable<ListTensorboardTimeSeriesResponse, TensorboardTimeSeries> response = tensorboardServiceClient.ListTensorboardTimeSeriesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TensorboardTimeSeries item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTensorboardTimeSeriesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardTimeSeries item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardTimeSeries> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardTimeSeries item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardTimeSeriesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTensorboardTimeSeriesResponse, TensorboardTimeSeries> ListTensorboardTimeSeriesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists TensorboardTimeSeries in a Location.

Parameters
NameDescription
parentstring

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTensorboardTimeSeriesResponseTensorboardTimeSeries

A pageable asynchronous sequence of TensorboardTimeSeries resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]";
// Make the request
PagedAsyncEnumerable<ListTensorboardTimeSeriesResponse, TensorboardTimeSeries> response = tensorboardServiceClient.ListTensorboardTimeSeriesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TensorboardTimeSeries item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTensorboardTimeSeriesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TensorboardTimeSeries item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TensorboardTimeSeries> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TensorboardTimeSeries item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboards(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListTensorboardsResponse, Tensorboard> ListTensorboards(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Tensorboards in a Location.

Parameters
NameDescription
parentLocationName

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTensorboardsResponseTensorboard

A pageable sequence of Tensorboard resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListTensorboardsResponse, Tensorboard> response = tensorboardServiceClient.ListTensorboards(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Tensorboard item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTensorboardsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Tensorboard item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tensorboard> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tensorboard item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboards(ListTensorboardsRequest, CallSettings)

public virtual PagedEnumerable<ListTensorboardsResponse, Tensorboard> ListTensorboards(ListTensorboardsRequest request, CallSettings callSettings = null)

Lists Tensorboards in a Location.

Parameters
NameDescription
requestListTensorboardsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTensorboardsResponseTensorboard

A pageable sequence of Tensorboard resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
ListTensorboardsRequest request = new ListTensorboardsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
    ReadMask = new FieldMask(),
};
// Make the request
PagedEnumerable<ListTensorboardsResponse, Tensorboard> response = tensorboardServiceClient.ListTensorboards(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Tensorboard item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTensorboardsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Tensorboard item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tensorboard> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tensorboard item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboards(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListTensorboardsResponse, Tensorboard> ListTensorboards(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Tensorboards in a Location.

Parameters
NameDescription
parentstring

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTensorboardsResponseTensorboard

A pageable sequence of Tensorboard resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListTensorboardsResponse, Tensorboard> response = tensorboardServiceClient.ListTensorboards(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Tensorboard item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTensorboardsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Tensorboard item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tensorboard> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tensorboard item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTensorboardsResponse, Tensorboard> ListTensorboardsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Tensorboards in a Location.

Parameters
NameDescription
parentLocationName

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTensorboardsResponseTensorboard

A pageable asynchronous sequence of Tensorboard resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListTensorboardsResponse, Tensorboard> response = tensorboardServiceClient.ListTensorboardsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Tensorboard item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTensorboardsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Tensorboard item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tensorboard> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tensorboard item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardsAsync(ListTensorboardsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListTensorboardsResponse, Tensorboard> ListTensorboardsAsync(ListTensorboardsRequest request, CallSettings callSettings = null)

Lists Tensorboards in a Location.

Parameters
NameDescription
requestListTensorboardsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTensorboardsResponseTensorboard

A pageable asynchronous sequence of Tensorboard resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
ListTensorboardsRequest request = new ListTensorboardsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
    ReadMask = new FieldMask(),
};
// Make the request
PagedAsyncEnumerable<ListTensorboardsResponse, Tensorboard> response = tensorboardServiceClient.ListTensorboardsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Tensorboard item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTensorboardsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Tensorboard item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tensorboard> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tensorboard item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTensorboardsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListTensorboardsResponse, Tensorboard> ListTensorboardsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Tensorboards in a Location.

Parameters
NameDescription
parentstring

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

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTensorboardsResponseTensorboard

A pageable asynchronous sequence of Tensorboard resources.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListTensorboardsResponse, Tensorboard> response = tensorboardServiceClient.ListTensorboardsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Tensorboard item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTensorboardsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Tensorboard item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Tensorboard> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Tensorboard item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCreateTensorboard(string, CallSettings)

public virtual Operation<Tensorboard, CreateTensorboardOperationMetadata> PollOnceCreateTensorboard(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateTensorboard .

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationTensorboardCreateTensorboardOperationMetadata

The result of polling the operation.

PollOnceCreateTensorboardAsync(string, CallSettings)

public virtual Task<Operation<Tensorboard, CreateTensorboardOperationMetadata>> PollOnceCreateTensorboardAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateTensorboard.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationTensorboardCreateTensorboardOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteTensorboard(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> PollOnceDeleteTensorboard(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteTensorboard .

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The result of polling the operation.

PollOnceDeleteTensorboardAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> PollOnceDeleteTensorboardAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteTensorboard.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteTensorboardExperiment(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> PollOnceDeleteTensorboardExperiment(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteTensorboardExperiment.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The result of polling the operation.

PollOnceDeleteTensorboardExperimentAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> PollOnceDeleteTensorboardExperimentAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteTensorboardExperiment.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteTensorboardRun(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> PollOnceDeleteTensorboardRun(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteTensorboardRun .

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The result of polling the operation.

PollOnceDeleteTensorboardRunAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> PollOnceDeleteTensorboardRunAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteTensorboardRun.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteTensorboardTimeSeries(string, CallSettings)

public virtual Operation<Empty, DeleteOperationMetadata> PollOnceDeleteTensorboardTimeSeries(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteTensorboardTimeSeries.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteOperationMetadata

The result of polling the operation.

PollOnceDeleteTensorboardTimeSeriesAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteOperationMetadata>> PollOnceDeleteTensorboardTimeSeriesAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteTensorboardTimeSeries.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateTensorboard(string, CallSettings)

public virtual Operation<Tensorboard, UpdateTensorboardOperationMetadata> PollOnceUpdateTensorboard(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateTensorboard .

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationTensorboardUpdateTensorboardOperationMetadata

The result of polling the operation.

PollOnceUpdateTensorboardAsync(string, CallSettings)

public virtual Task<Operation<Tensorboard, UpdateTensorboardOperationMetadata>> PollOnceUpdateTensorboardAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateTensorboard.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationTensorboardUpdateTensorboardOperationMetadata

A task representing the result of polling the operation.

ReadTensorboardBlobData(ReadTensorboardBlobDataRequest, CallSettings)

public virtual TensorboardServiceClient.ReadTensorboardBlobDataStream ReadTensorboardBlobData(ReadTensorboardBlobDataRequest request, CallSettings callSettings = null)

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.

Parameters
NameDescription
requestReadTensorboardBlobDataRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardServiceClientReadTensorboardBlobDataStream

The server stream.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
ReadTensorboardBlobDataRequest request = new ReadTensorboardBlobDataRequest
{
    TimeSeriesAsTensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
    BlobIds = { "", },
};
// Make the request, returning a streaming response
using TensorboardServiceClient.ReadTensorboardBlobDataStream response = tensorboardServiceClient.ReadTensorboardBlobData(request);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadTensorboardBlobDataResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadTensorboardBlobDataResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

ReadTensorboardBlobData(TensorboardTimeSeriesName, CallSettings)

public virtual TensorboardServiceClient.ReadTensorboardBlobDataStream ReadTensorboardBlobData(TensorboardTimeSeriesName timeSeries, CallSettings callSettings = null)

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.

Parameters
NameDescription
timeSeriesTensorboardTimeSeriesName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardServiceClientReadTensorboardBlobDataStream

The server stream.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardTimeSeriesName timeSeries = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
// Make the request, returning a streaming response
using TensorboardServiceClient.ReadTensorboardBlobDataStream response = tensorboardServiceClient.ReadTensorboardBlobData(timeSeries);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadTensorboardBlobDataResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadTensorboardBlobDataResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

ReadTensorboardBlobData(string, CallSettings)

public virtual TensorboardServiceClient.ReadTensorboardBlobDataStream ReadTensorboardBlobData(string timeSeries, CallSettings callSettings = null)

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.

Parameters
NameDescription
timeSeriesstring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardServiceClientReadTensorboardBlobDataStream

The server stream.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string timeSeries = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]/timeSeries/[TIME_SERIES]";
// Make the request, returning a streaming response
using TensorboardServiceClient.ReadTensorboardBlobDataStream response = tensorboardServiceClient.ReadTensorboardBlobData(timeSeries);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadTensorboardBlobDataResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadTensorboardBlobDataResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

ReadTensorboardSize(ReadTensorboardSizeRequest, CallSettings)

public virtual ReadTensorboardSizeResponse ReadTensorboardSize(ReadTensorboardSizeRequest request, CallSettings callSettings = null)

Returns the storage size for a given TensorBoard instance.

Parameters
NameDescription
requestReadTensorboardSizeRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ReadTensorboardSizeResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
ReadTensorboardSizeRequest request = new ReadTensorboardSizeRequest
{
    TensorboardAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
};
// Make the request
ReadTensorboardSizeResponse response = tensorboardServiceClient.ReadTensorboardSize(request);

ReadTensorboardSize(TensorboardName, CallSettings)

public virtual ReadTensorboardSizeResponse ReadTensorboardSize(TensorboardName tensorboard, CallSettings callSettings = null)

Returns the storage size for a given TensorBoard instance.

Parameters
NameDescription
tensorboardTensorboardName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ReadTensorboardSizeResponse

The RPC response.

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

ReadTensorboardSize(string, CallSettings)

public virtual ReadTensorboardSizeResponse ReadTensorboardSize(string tensorboard, CallSettings callSettings = null)

Returns the storage size for a given TensorBoard instance.

Parameters
NameDescription
tensorboardstring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ReadTensorboardSizeResponse

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
ReadTensorboardSizeResponse response = tensorboardServiceClient.ReadTensorboardSize(tensorboard);

ReadTensorboardSizeAsync(ReadTensorboardSizeRequest, CallSettings)

public virtual Task<ReadTensorboardSizeResponse> ReadTensorboardSizeAsync(ReadTensorboardSizeRequest request, CallSettings callSettings = null)

Returns the storage size for a given TensorBoard instance.

Parameters
NameDescription
requestReadTensorboardSizeRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskReadTensorboardSizeResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
ReadTensorboardSizeRequest request = new ReadTensorboardSizeRequest
{
    TensorboardAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
};
// Make the request
ReadTensorboardSizeResponse response = await tensorboardServiceClient.ReadTensorboardSizeAsync(request);

ReadTensorboardSizeAsync(ReadTensorboardSizeRequest, CancellationToken)

public virtual Task<ReadTensorboardSizeResponse> ReadTensorboardSizeAsync(ReadTensorboardSizeRequest request, CancellationToken cancellationToken)

Returns the storage size for a given TensorBoard instance.

Parameters
NameDescription
requestReadTensorboardSizeRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskReadTensorboardSizeResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
ReadTensorboardSizeRequest request = new ReadTensorboardSizeRequest
{
    TensorboardAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
};
// Make the request
ReadTensorboardSizeResponse response = await tensorboardServiceClient.ReadTensorboardSizeAsync(request);

ReadTensorboardSizeAsync(TensorboardName, CallSettings)

public virtual Task<ReadTensorboardSizeResponse> ReadTensorboardSizeAsync(TensorboardName tensorboard, CallSettings callSettings = null)

Returns the storage size for a given TensorBoard instance.

Parameters
NameDescription
tensorboardTensorboardName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskReadTensorboardSizeResponse

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
ReadTensorboardSizeResponse response = await tensorboardServiceClient.ReadTensorboardSizeAsync(tensorboard);

ReadTensorboardSizeAsync(TensorboardName, CancellationToken)

public virtual Task<ReadTensorboardSizeResponse> ReadTensorboardSizeAsync(TensorboardName tensorboard, CancellationToken cancellationToken)

Returns the storage size for a given TensorBoard instance.

Parameters
NameDescription
tensorboardTensorboardName

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskReadTensorboardSizeResponse

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
ReadTensorboardSizeResponse response = await tensorboardServiceClient.ReadTensorboardSizeAsync(tensorboard);

ReadTensorboardSizeAsync(string, CallSettings)

public virtual Task<ReadTensorboardSizeResponse> ReadTensorboardSizeAsync(string tensorboard, CallSettings callSettings = null)

Returns the storage size for a given TensorBoard instance.

Parameters
NameDescription
tensorboardstring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskReadTensorboardSizeResponse

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
ReadTensorboardSizeResponse response = await tensorboardServiceClient.ReadTensorboardSizeAsync(tensorboard);

ReadTensorboardSizeAsync(string, CancellationToken)

public virtual Task<ReadTensorboardSizeResponse> ReadTensorboardSizeAsync(string tensorboard, CancellationToken cancellationToken)

Returns the storage size for a given TensorBoard instance.

Parameters
NameDescription
tensorboardstring

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskReadTensorboardSizeResponse

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
ReadTensorboardSizeResponse response = await tensorboardServiceClient.ReadTensorboardSizeAsync(tensorboard);

ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest, CallSettings)

public virtual ReadTensorboardTimeSeriesDataResponse ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest request, CallSettings callSettings = null)

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Parameters
NameDescription
requestReadTensorboardTimeSeriesDataRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ReadTensorboardTimeSeriesDataResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
ReadTensorboardTimeSeriesDataRequest request = new ReadTensorboardTimeSeriesDataRequest
{
    TensorboardTimeSeriesAsTensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
    MaxDataPoints = 0,
    Filter = "",
};
// Make the request
ReadTensorboardTimeSeriesDataResponse response = tensorboardServiceClient.ReadTensorboardTimeSeriesData(request);

ReadTensorboardTimeSeriesData(TensorboardTimeSeriesName, CallSettings)

public virtual ReadTensorboardTimeSeriesDataResponse ReadTensorboardTimeSeriesData(TensorboardTimeSeriesName tensorboardTimeSeries, CallSettings callSettings = null)

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Parameters
NameDescription
tensorboardTimeSeriesTensorboardTimeSeriesName

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}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ReadTensorboardTimeSeriesDataResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardTimeSeriesName tensorboardTimeSeries = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
// Make the request
ReadTensorboardTimeSeriesDataResponse response = tensorboardServiceClient.ReadTensorboardTimeSeriesData(tensorboardTimeSeries);

ReadTensorboardTimeSeriesData(string, CallSettings)

public virtual ReadTensorboardTimeSeriesDataResponse ReadTensorboardTimeSeriesData(string tensorboardTimeSeries, CallSettings callSettings = null)

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Parameters
NameDescription
tensorboardTimeSeriesstring

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}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ReadTensorboardTimeSeriesDataResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string tensorboardTimeSeries = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]/timeSeries/[TIME_SERIES]";
// Make the request
ReadTensorboardTimeSeriesDataResponse response = tensorboardServiceClient.ReadTensorboardTimeSeriesData(tensorboardTimeSeries);

ReadTensorboardTimeSeriesDataAsync(ReadTensorboardTimeSeriesDataRequest, CallSettings)

public virtual Task<ReadTensorboardTimeSeriesDataResponse> ReadTensorboardTimeSeriesDataAsync(ReadTensorboardTimeSeriesDataRequest request, CallSettings callSettings = null)

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Parameters
NameDescription
requestReadTensorboardTimeSeriesDataRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskReadTensorboardTimeSeriesDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
ReadTensorboardTimeSeriesDataRequest request = new ReadTensorboardTimeSeriesDataRequest
{
    TensorboardTimeSeriesAsTensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
    MaxDataPoints = 0,
    Filter = "",
};
// Make the request
ReadTensorboardTimeSeriesDataResponse response = await tensorboardServiceClient.ReadTensorboardTimeSeriesDataAsync(request);

ReadTensorboardTimeSeriesDataAsync(ReadTensorboardTimeSeriesDataRequest, CancellationToken)

public virtual Task<ReadTensorboardTimeSeriesDataResponse> ReadTensorboardTimeSeriesDataAsync(ReadTensorboardTimeSeriesDataRequest request, CancellationToken cancellationToken)

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Parameters
NameDescription
requestReadTensorboardTimeSeriesDataRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskReadTensorboardTimeSeriesDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
ReadTensorboardTimeSeriesDataRequest request = new ReadTensorboardTimeSeriesDataRequest
{
    TensorboardTimeSeriesAsTensorboardTimeSeriesName = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]"),
    MaxDataPoints = 0,
    Filter = "",
};
// Make the request
ReadTensorboardTimeSeriesDataResponse response = await tensorboardServiceClient.ReadTensorboardTimeSeriesDataAsync(request);

ReadTensorboardTimeSeriesDataAsync(TensorboardTimeSeriesName, CallSettings)

public virtual Task<ReadTensorboardTimeSeriesDataResponse> ReadTensorboardTimeSeriesDataAsync(TensorboardTimeSeriesName tensorboardTimeSeries, CallSettings callSettings = null)

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Parameters
NameDescription
tensorboardTimeSeriesTensorboardTimeSeriesName

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}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskReadTensorboardTimeSeriesDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardTimeSeriesName tensorboardTimeSeries = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
// Make the request
ReadTensorboardTimeSeriesDataResponse response = await tensorboardServiceClient.ReadTensorboardTimeSeriesDataAsync(tensorboardTimeSeries);

ReadTensorboardTimeSeriesDataAsync(TensorboardTimeSeriesName, CancellationToken)

public virtual Task<ReadTensorboardTimeSeriesDataResponse> ReadTensorboardTimeSeriesDataAsync(TensorboardTimeSeriesName tensorboardTimeSeries, CancellationToken cancellationToken)

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Parameters
NameDescription
tensorboardTimeSeriesTensorboardTimeSeriesName

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}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskReadTensorboardTimeSeriesDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardTimeSeriesName tensorboardTimeSeries = TensorboardTimeSeriesName.FromProjectLocationTensorboardExperimentRunTimeSeries("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]", "[TIME_SERIES]");
// Make the request
ReadTensorboardTimeSeriesDataResponse response = await tensorboardServiceClient.ReadTensorboardTimeSeriesDataAsync(tensorboardTimeSeries);

ReadTensorboardTimeSeriesDataAsync(string, CallSettings)

public virtual Task<ReadTensorboardTimeSeriesDataResponse> ReadTensorboardTimeSeriesDataAsync(string tensorboardTimeSeries, CallSettings callSettings = null)

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Parameters
NameDescription
tensorboardTimeSeriesstring

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}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskReadTensorboardTimeSeriesDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string tensorboardTimeSeries = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]/timeSeries/[TIME_SERIES]";
// Make the request
ReadTensorboardTimeSeriesDataResponse response = await tensorboardServiceClient.ReadTensorboardTimeSeriesDataAsync(tensorboardTimeSeries);

ReadTensorboardTimeSeriesDataAsync(string, CancellationToken)

public virtual Task<ReadTensorboardTimeSeriesDataResponse> ReadTensorboardTimeSeriesDataAsync(string tensorboardTimeSeries, CancellationToken cancellationToken)

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Parameters
NameDescription
tensorboardTimeSeriesstring

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}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskReadTensorboardTimeSeriesDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string tensorboardTimeSeries = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]/timeSeries/[TIME_SERIES]";
// Make the request
ReadTensorboardTimeSeriesDataResponse response = await tensorboardServiceClient.ReadTensorboardTimeSeriesDataAsync(tensorboardTimeSeries);

ReadTensorboardUsage(ReadTensorboardUsageRequest, CallSettings)

public virtual ReadTensorboardUsageResponse ReadTensorboardUsage(ReadTensorboardUsageRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestReadTensorboardUsageRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ReadTensorboardUsageResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
ReadTensorboardUsageRequest request = new ReadTensorboardUsageRequest
{
    TensorboardAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
};
// Make the request
ReadTensorboardUsageResponse response = tensorboardServiceClient.ReadTensorboardUsage(request);

ReadTensorboardUsage(TensorboardName, CallSettings)

public virtual ReadTensorboardUsageResponse ReadTensorboardUsage(TensorboardName tensorboard, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardTensorboardName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ReadTensorboardUsageResponse

The RPC response.

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

ReadTensorboardUsage(string, CallSettings)

public virtual ReadTensorboardUsageResponse ReadTensorboardUsage(string tensorboard, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardstring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ReadTensorboardUsageResponse

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
ReadTensorboardUsageResponse response = tensorboardServiceClient.ReadTensorboardUsage(tensorboard);

ReadTensorboardUsageAsync(ReadTensorboardUsageRequest, CallSettings)

public virtual Task<ReadTensorboardUsageResponse> ReadTensorboardUsageAsync(ReadTensorboardUsageRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestReadTensorboardUsageRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskReadTensorboardUsageResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
ReadTensorboardUsageRequest request = new ReadTensorboardUsageRequest
{
    TensorboardAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
};
// Make the request
ReadTensorboardUsageResponse response = await tensorboardServiceClient.ReadTensorboardUsageAsync(request);

ReadTensorboardUsageAsync(ReadTensorboardUsageRequest, CancellationToken)

public virtual Task<ReadTensorboardUsageResponse> ReadTensorboardUsageAsync(ReadTensorboardUsageRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestReadTensorboardUsageRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskReadTensorboardUsageResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
ReadTensorboardUsageRequest request = new ReadTensorboardUsageRequest
{
    TensorboardAsTensorboardName = TensorboardName.FromProjectLocationTensorboard("[PROJECT]", "[LOCATION]", "[TENSORBOARD]"),
};
// Make the request
ReadTensorboardUsageResponse response = await tensorboardServiceClient.ReadTensorboardUsageAsync(request);

ReadTensorboardUsageAsync(TensorboardName, CallSettings)

public virtual Task<ReadTensorboardUsageResponse> ReadTensorboardUsageAsync(TensorboardName tensorboard, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardTensorboardName

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskReadTensorboardUsageResponse

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
ReadTensorboardUsageResponse response = await tensorboardServiceClient.ReadTensorboardUsageAsync(tensorboard);

ReadTensorboardUsageAsync(TensorboardName, CancellationToken)

public virtual Task<ReadTensorboardUsageResponse> ReadTensorboardUsageAsync(TensorboardName tensorboard, CancellationToken cancellationToken)

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

Parameters
NameDescription
tensorboardTensorboardName

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskReadTensorboardUsageResponse

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
ReadTensorboardUsageResponse response = await tensorboardServiceClient.ReadTensorboardUsageAsync(tensorboard);

ReadTensorboardUsageAsync(string, CallSettings)

public virtual Task<ReadTensorboardUsageResponse> ReadTensorboardUsageAsync(string tensorboard, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardstring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskReadTensorboardUsageResponse

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
ReadTensorboardUsageResponse response = await tensorboardServiceClient.ReadTensorboardUsageAsync(tensorboard);

ReadTensorboardUsageAsync(string, CancellationToken)

public virtual Task<ReadTensorboardUsageResponse> ReadTensorboardUsageAsync(string tensorboard, CancellationToken cancellationToken)

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

Parameters
NameDescription
tensorboardstring

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskReadTensorboardUsageResponse

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
ReadTensorboardUsageResponse response = await tensorboardServiceClient.ReadTensorboardUsageAsync(tensorboard);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
TypeDescription
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateTensorboard(Tensorboard, FieldMask, CallSettings)

public virtual Operation<Tensorboard, UpdateTensorboardOperationMetadata> UpdateTensorboard(Tensorboard tensorboard, FieldMask updateMask, CallSettings callSettings = null)

Updates a Tensorboard.

Parameters
NameDescription
tensorboardTensorboard

Required. The Tensorboard's name field is used to identify the Tensorboard to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

updateMaskFieldMask

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 is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationTensorboardUpdateTensorboardOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
Tensorboard tensorboard = new Tensorboard();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Tensorboard, UpdateTensorboardOperationMetadata> response = tensorboardServiceClient.UpdateTensorboard(tensorboard, updateMask);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, UpdateTensorboardOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, UpdateTensorboardOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceUpdateTensorboard(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

UpdateTensorboard(UpdateTensorboardRequest, CallSettings)

public virtual Operation<Tensorboard, UpdateTensorboardOperationMetadata> UpdateTensorboard(UpdateTensorboardRequest request, CallSettings callSettings = null)

Updates a Tensorboard.

Parameters
NameDescription
requestUpdateTensorboardRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationTensorboardUpdateTensorboardOperationMetadata

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
UpdateTensorboardRequest request = new UpdateTensorboardRequest
{
    UpdateMask = new FieldMask(),
    Tensorboard = new Tensorboard(),
};
// Make the request
Operation<Tensorboard, UpdateTensorboardOperationMetadata> response = tensorboardServiceClient.UpdateTensorboard(request);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, UpdateTensorboardOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, UpdateTensorboardOperationMetadata> retrievedResponse = tensorboardServiceClient.PollOnceUpdateTensorboard(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

UpdateTensorboardAsync(Tensorboard, FieldMask, CallSettings)

public virtual Task<Operation<Tensorboard, UpdateTensorboardOperationMetadata>> UpdateTensorboardAsync(Tensorboard tensorboard, FieldMask updateMask, CallSettings callSettings = null)

Updates a Tensorboard.

Parameters
NameDescription
tensorboardTensorboard

Required. The Tensorboard's name field is used to identify the Tensorboard to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

updateMaskFieldMask

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 is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationTensorboardUpdateTensorboardOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
Tensorboard tensorboard = new Tensorboard();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Tensorboard, UpdateTensorboardOperationMetadata> response = await tensorboardServiceClient.UpdateTensorboardAsync(tensorboard, updateMask);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, UpdateTensorboardOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, UpdateTensorboardOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceUpdateTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

UpdateTensorboardAsync(Tensorboard, FieldMask, CancellationToken)

public virtual Task<Operation<Tensorboard, UpdateTensorboardOperationMetadata>> UpdateTensorboardAsync(Tensorboard tensorboard, FieldMask updateMask, CancellationToken cancellationToken)

Updates a Tensorboard.

Parameters
NameDescription
tensorboardTensorboard

Required. The Tensorboard's name field is used to identify the Tensorboard to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

updateMaskFieldMask

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 is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationTensorboardUpdateTensorboardOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
Tensorboard tensorboard = new Tensorboard();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Tensorboard, UpdateTensorboardOperationMetadata> response = await tensorboardServiceClient.UpdateTensorboardAsync(tensorboard, updateMask);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, UpdateTensorboardOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, UpdateTensorboardOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceUpdateTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

UpdateTensorboardAsync(UpdateTensorboardRequest, CallSettings)

public virtual Task<Operation<Tensorboard, UpdateTensorboardOperationMetadata>> UpdateTensorboardAsync(UpdateTensorboardRequest request, CallSettings callSettings = null)

Updates a Tensorboard.

Parameters
NameDescription
requestUpdateTensorboardRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationTensorboardUpdateTensorboardOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateTensorboardRequest request = new UpdateTensorboardRequest
{
    UpdateMask = new FieldMask(),
    Tensorboard = new Tensorboard(),
};
// Make the request
Operation<Tensorboard, UpdateTensorboardOperationMetadata> response = await tensorboardServiceClient.UpdateTensorboardAsync(request);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, UpdateTensorboardOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, UpdateTensorboardOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceUpdateTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

UpdateTensorboardAsync(UpdateTensorboardRequest, CancellationToken)

public virtual Task<Operation<Tensorboard, UpdateTensorboardOperationMetadata>> UpdateTensorboardAsync(UpdateTensorboardRequest request, CancellationToken cancellationToken)

Updates a Tensorboard.

Parameters
NameDescription
requestUpdateTensorboardRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationTensorboardUpdateTensorboardOperationMetadata

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateTensorboardRequest request = new UpdateTensorboardRequest
{
    UpdateMask = new FieldMask(),
    Tensorboard = new Tensorboard(),
};
// Make the request
Operation<Tensorboard, UpdateTensorboardOperationMetadata> response = await tensorboardServiceClient.UpdateTensorboardAsync(request);

// Poll until the returned long-running operation is complete
Operation<Tensorboard, UpdateTensorboardOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Tensorboard result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Tensorboard, UpdateTensorboardOperationMetadata> retrievedResponse = await tensorboardServiceClient.PollOnceUpdateTensorboardAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Tensorboard retrievedResult = retrievedResponse.Result;
}

UpdateTensorboardExperiment(TensorboardExperiment, FieldMask, CallSettings)

public virtual TensorboardExperiment UpdateTensorboardExperiment(TensorboardExperiment tensorboardExperiment, FieldMask updateMask, CallSettings callSettings = null)

Updates a TensorboardExperiment.

Parameters
NameDescription
tensorboardExperimentTensorboardExperiment

Required. The TensorboardExperiment's name field is used to identify the TensorboardExperiment to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

updateMaskFieldMask

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 is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardExperiment

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardExperiment tensorboardExperiment = new TensorboardExperiment();
FieldMask updateMask = new FieldMask();
// Make the request
TensorboardExperiment response = tensorboardServiceClient.UpdateTensorboardExperiment(tensorboardExperiment, updateMask);

UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest, CallSettings)

public virtual TensorboardExperiment UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest request, CallSettings callSettings = null)

Updates a TensorboardExperiment.

Parameters
NameDescription
requestUpdateTensorboardExperimentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardExperiment

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
UpdateTensorboardExperimentRequest request = new UpdateTensorboardExperimentRequest
{
    UpdateMask = new FieldMask(),
    TensorboardExperiment = new TensorboardExperiment(),
};
// Make the request
TensorboardExperiment response = tensorboardServiceClient.UpdateTensorboardExperiment(request);

UpdateTensorboardExperimentAsync(TensorboardExperiment, FieldMask, CallSettings)

public virtual Task<TensorboardExperiment> UpdateTensorboardExperimentAsync(TensorboardExperiment tensorboardExperiment, FieldMask updateMask, CallSettings callSettings = null)

Updates a TensorboardExperiment.

Parameters
NameDescription
tensorboardExperimentTensorboardExperiment

Required. The TensorboardExperiment's name field is used to identify the TensorboardExperiment to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

updateMaskFieldMask

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 is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardExperiment

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardExperiment tensorboardExperiment = new TensorboardExperiment();
FieldMask updateMask = new FieldMask();
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.UpdateTensorboardExperimentAsync(tensorboardExperiment, updateMask);

UpdateTensorboardExperimentAsync(TensorboardExperiment, FieldMask, CancellationToken)

public virtual Task<TensorboardExperiment> UpdateTensorboardExperimentAsync(TensorboardExperiment tensorboardExperiment, FieldMask updateMask, CancellationToken cancellationToken)

Updates a TensorboardExperiment.

Parameters
NameDescription
tensorboardExperimentTensorboardExperiment

Required. The TensorboardExperiment's name field is used to identify the TensorboardExperiment to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

updateMaskFieldMask

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 is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardExperiment

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardExperiment tensorboardExperiment = new TensorboardExperiment();
FieldMask updateMask = new FieldMask();
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.UpdateTensorboardExperimentAsync(tensorboardExperiment, updateMask);

UpdateTensorboardExperimentAsync(UpdateTensorboardExperimentRequest, CallSettings)

public virtual Task<TensorboardExperiment> UpdateTensorboardExperimentAsync(UpdateTensorboardExperimentRequest request, CallSettings callSettings = null)

Updates a TensorboardExperiment.

Parameters
NameDescription
requestUpdateTensorboardExperimentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardExperiment

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateTensorboardExperimentRequest request = new UpdateTensorboardExperimentRequest
{
    UpdateMask = new FieldMask(),
    TensorboardExperiment = new TensorboardExperiment(),
};
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.UpdateTensorboardExperimentAsync(request);

UpdateTensorboardExperimentAsync(UpdateTensorboardExperimentRequest, CancellationToken)

public virtual Task<TensorboardExperiment> UpdateTensorboardExperimentAsync(UpdateTensorboardExperimentRequest request, CancellationToken cancellationToken)

Updates a TensorboardExperiment.

Parameters
NameDescription
requestUpdateTensorboardExperimentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardExperiment

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateTensorboardExperimentRequest request = new UpdateTensorboardExperimentRequest
{
    UpdateMask = new FieldMask(),
    TensorboardExperiment = new TensorboardExperiment(),
};
// Make the request
TensorboardExperiment response = await tensorboardServiceClient.UpdateTensorboardExperimentAsync(request);

UpdateTensorboardRun(TensorboardRun, FieldMask, CallSettings)

public virtual TensorboardRun UpdateTensorboardRun(TensorboardRun tensorboardRun, FieldMask updateMask, CallSettings callSettings = null)

Updates a TensorboardRun.

Parameters
NameDescription
tensorboardRunTensorboardRun

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}

updateMaskFieldMask

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 is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardRun

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardRun tensorboardRun = new TensorboardRun();
FieldMask updateMask = new FieldMask();
// Make the request
TensorboardRun response = tensorboardServiceClient.UpdateTensorboardRun(tensorboardRun, updateMask);

UpdateTensorboardRun(UpdateTensorboardRunRequest, CallSettings)

public virtual TensorboardRun UpdateTensorboardRun(UpdateTensorboardRunRequest request, CallSettings callSettings = null)

Updates a TensorboardRun.

Parameters
NameDescription
requestUpdateTensorboardRunRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardRun

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
UpdateTensorboardRunRequest request = new UpdateTensorboardRunRequest
{
    UpdateMask = new FieldMask(),
    TensorboardRun = new TensorboardRun(),
};
// Make the request
TensorboardRun response = tensorboardServiceClient.UpdateTensorboardRun(request);

UpdateTensorboardRunAsync(TensorboardRun, FieldMask, CallSettings)

public virtual Task<TensorboardRun> UpdateTensorboardRunAsync(TensorboardRun tensorboardRun, FieldMask updateMask, CallSettings callSettings = null)

Updates a TensorboardRun.

Parameters
NameDescription
tensorboardRunTensorboardRun

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}

updateMaskFieldMask

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 is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardRun tensorboardRun = new TensorboardRun();
FieldMask updateMask = new FieldMask();
// Make the request
TensorboardRun response = await tensorboardServiceClient.UpdateTensorboardRunAsync(tensorboardRun, updateMask);

UpdateTensorboardRunAsync(TensorboardRun, FieldMask, CancellationToken)

public virtual Task<TensorboardRun> UpdateTensorboardRunAsync(TensorboardRun tensorboardRun, FieldMask updateMask, CancellationToken cancellationToken)

Updates a TensorboardRun.

Parameters
NameDescription
tensorboardRunTensorboardRun

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}

updateMaskFieldMask

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 is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardRun tensorboardRun = new TensorboardRun();
FieldMask updateMask = new FieldMask();
// Make the request
TensorboardRun response = await tensorboardServiceClient.UpdateTensorboardRunAsync(tensorboardRun, updateMask);

UpdateTensorboardRunAsync(UpdateTensorboardRunRequest, CallSettings)

public virtual Task<TensorboardRun> UpdateTensorboardRunAsync(UpdateTensorboardRunRequest request, CallSettings callSettings = null)

Updates a TensorboardRun.

Parameters
NameDescription
requestUpdateTensorboardRunRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateTensorboardRunRequest request = new UpdateTensorboardRunRequest
{
    UpdateMask = new FieldMask(),
    TensorboardRun = new TensorboardRun(),
};
// Make the request
TensorboardRun response = await tensorboardServiceClient.UpdateTensorboardRunAsync(request);

UpdateTensorboardRunAsync(UpdateTensorboardRunRequest, CancellationToken)

public virtual Task<TensorboardRun> UpdateTensorboardRunAsync(UpdateTensorboardRunRequest request, CancellationToken cancellationToken)

Updates a TensorboardRun.

Parameters
NameDescription
requestUpdateTensorboardRunRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardRun

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateTensorboardRunRequest request = new UpdateTensorboardRunRequest
{
    UpdateMask = new FieldMask(),
    TensorboardRun = new TensorboardRun(),
};
// Make the request
TensorboardRun response = await tensorboardServiceClient.UpdateTensorboardRunAsync(request);

UpdateTensorboardTimeSeries(TensorboardTimeSeries, FieldMask, CallSettings)

public virtual TensorboardTimeSeries UpdateTensorboardTimeSeries(TensorboardTimeSeries tensorboardTimeSeries, FieldMask updateMask, CallSettings callSettings = null)

Updates a TensorboardTimeSeries.

Parameters
NameDescription
tensorboardTimeSeriesTensorboardTimeSeries

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}

updateMaskFieldMask

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 is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardTimeSeries

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardTimeSeries tensorboardTimeSeries = new TensorboardTimeSeries();
FieldMask updateMask = new FieldMask();
// Make the request
TensorboardTimeSeries response = tensorboardServiceClient.UpdateTensorboardTimeSeries(tensorboardTimeSeries, updateMask);

UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest, CallSettings)

public virtual TensorboardTimeSeries UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Updates a TensorboardTimeSeries.

Parameters
NameDescription
requestUpdateTensorboardTimeSeriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TensorboardTimeSeries

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
UpdateTensorboardTimeSeriesRequest request = new UpdateTensorboardTimeSeriesRequest
{
    UpdateMask = new FieldMask(),
    TensorboardTimeSeries = new TensorboardTimeSeries(),
};
// Make the request
TensorboardTimeSeries response = tensorboardServiceClient.UpdateTensorboardTimeSeries(request);

UpdateTensorboardTimeSeriesAsync(TensorboardTimeSeries, FieldMask, CallSettings)

public virtual Task<TensorboardTimeSeries> UpdateTensorboardTimeSeriesAsync(TensorboardTimeSeries tensorboardTimeSeries, FieldMask updateMask, CallSettings callSettings = null)

Updates a TensorboardTimeSeries.

Parameters
NameDescription
tensorboardTimeSeriesTensorboardTimeSeries

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}

updateMaskFieldMask

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 is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardTimeSeries tensorboardTimeSeries = new TensorboardTimeSeries();
FieldMask updateMask = new FieldMask();
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.UpdateTensorboardTimeSeriesAsync(tensorboardTimeSeries, updateMask);

UpdateTensorboardTimeSeriesAsync(TensorboardTimeSeries, FieldMask, CancellationToken)

public virtual Task<TensorboardTimeSeries> UpdateTensorboardTimeSeriesAsync(TensorboardTimeSeries tensorboardTimeSeries, FieldMask updateMask, CancellationToken cancellationToken)

Updates a TensorboardTimeSeries.

Parameters
NameDescription
tensorboardTimeSeriesTensorboardTimeSeries

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}

updateMaskFieldMask

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 is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardTimeSeries tensorboardTimeSeries = new TensorboardTimeSeries();
FieldMask updateMask = new FieldMask();
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.UpdateTensorboardTimeSeriesAsync(tensorboardTimeSeries, updateMask);

UpdateTensorboardTimeSeriesAsync(UpdateTensorboardTimeSeriesRequest, CallSettings)

public virtual Task<TensorboardTimeSeries> UpdateTensorboardTimeSeriesAsync(UpdateTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Updates a TensorboardTimeSeries.

Parameters
NameDescription
requestUpdateTensorboardTimeSeriesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateTensorboardTimeSeriesRequest request = new UpdateTensorboardTimeSeriesRequest
{
    UpdateMask = new FieldMask(),
    TensorboardTimeSeries = new TensorboardTimeSeries(),
};
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.UpdateTensorboardTimeSeriesAsync(request);

UpdateTensorboardTimeSeriesAsync(UpdateTensorboardTimeSeriesRequest, CancellationToken)

public virtual Task<TensorboardTimeSeries> UpdateTensorboardTimeSeriesAsync(UpdateTensorboardTimeSeriesRequest request, CancellationToken cancellationToken)

Updates a TensorboardTimeSeries.

Parameters
NameDescription
requestUpdateTensorboardTimeSeriesRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTensorboardTimeSeries

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateTensorboardTimeSeriesRequest request = new UpdateTensorboardTimeSeriesRequest
{
    UpdateMask = new FieldMask(),
    TensorboardTimeSeries = new TensorboardTimeSeries(),
};
// Make the request
TensorboardTimeSeries response = await tensorboardServiceClient.UpdateTensorboardTimeSeriesAsync(request);

WriteTensorboardExperimentData(TensorboardExperimentName, IEnumerable<WriteTensorboardRunDataRequest>, CallSettings)

public virtual WriteTensorboardExperimentDataResponse WriteTensorboardExperimentData(TensorboardExperimentName tensorboardExperiment, IEnumerable<WriteTensorboardRunDataRequest> writeRunDataRequests, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardExperimentTensorboardExperimentName

Required. The resource name of the TensorboardExperiment to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

writeRunDataRequestsIEnumerableWriteTensorboardRunDataRequest

Required. Requests containing per-run TensorboardTimeSeries data to write.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
WriteTensorboardExperimentDataResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardExperimentName tensorboardExperiment = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
IEnumerable<WriteTensorboardRunDataRequest> writeRunDataRequests = new WriteTensorboardRunDataRequest[]
{
    new WriteTensorboardRunDataRequest(),
};
// Make the request
WriteTensorboardExperimentDataResponse response = tensorboardServiceClient.WriteTensorboardExperimentData(tensorboardExperiment, writeRunDataRequests);

WriteTensorboardExperimentData(WriteTensorboardExperimentDataRequest, CallSettings)

public virtual WriteTensorboardExperimentDataResponse WriteTensorboardExperimentData(WriteTensorboardExperimentDataRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestWriteTensorboardExperimentDataRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
WriteTensorboardExperimentDataResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
WriteTensorboardExperimentDataRequest request = new WriteTensorboardExperimentDataRequest
{
    TensorboardExperimentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    WriteRunDataRequests =
    {
        new WriteTensorboardRunDataRequest(),
    },
};
// Make the request
WriteTensorboardExperimentDataResponse response = tensorboardServiceClient.WriteTensorboardExperimentData(request);

WriteTensorboardExperimentData(string, IEnumerable<WriteTensorboardRunDataRequest>, CallSettings)

public virtual WriteTensorboardExperimentDataResponse WriteTensorboardExperimentData(string tensorboardExperiment, IEnumerable<WriteTensorboardRunDataRequest> writeRunDataRequests, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardExperimentstring

Required. The resource name of the TensorboardExperiment to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

writeRunDataRequestsIEnumerableWriteTensorboardRunDataRequest

Required. Requests containing per-run TensorboardTimeSeries data to write.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
WriteTensorboardExperimentDataResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string tensorboardExperiment = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
IEnumerable<WriteTensorboardRunDataRequest> writeRunDataRequests = new WriteTensorboardRunDataRequest[]
{
    new WriteTensorboardRunDataRequest(),
};
// Make the request
WriteTensorboardExperimentDataResponse response = tensorboardServiceClient.WriteTensorboardExperimentData(tensorboardExperiment, writeRunDataRequests);

WriteTensorboardExperimentDataAsync(TensorboardExperimentName, IEnumerable<WriteTensorboardRunDataRequest>, CallSettings)

public virtual Task<WriteTensorboardExperimentDataResponse> WriteTensorboardExperimentDataAsync(TensorboardExperimentName tensorboardExperiment, IEnumerable<WriteTensorboardRunDataRequest> writeRunDataRequests, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardExperimentTensorboardExperimentName

Required. The resource name of the TensorboardExperiment to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

writeRunDataRequestsIEnumerableWriteTensorboardRunDataRequest

Required. Requests containing per-run TensorboardTimeSeries data to write.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskWriteTensorboardExperimentDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardExperimentName tensorboardExperiment = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
IEnumerable<WriteTensorboardRunDataRequest> writeRunDataRequests = new WriteTensorboardRunDataRequest[]
{
    new WriteTensorboardRunDataRequest(),
};
// Make the request
WriteTensorboardExperimentDataResponse response = await tensorboardServiceClient.WriteTensorboardExperimentDataAsync(tensorboardExperiment, writeRunDataRequests);

WriteTensorboardExperimentDataAsync(TensorboardExperimentName, IEnumerable<WriteTensorboardRunDataRequest>, CancellationToken)

public virtual Task<WriteTensorboardExperimentDataResponse> WriteTensorboardExperimentDataAsync(TensorboardExperimentName tensorboardExperiment, IEnumerable<WriteTensorboardRunDataRequest> writeRunDataRequests, CancellationToken cancellationToken)

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

Parameters
NameDescription
tensorboardExperimentTensorboardExperimentName

Required. The resource name of the TensorboardExperiment to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

writeRunDataRequestsIEnumerableWriteTensorboardRunDataRequest

Required. Requests containing per-run TensorboardTimeSeries data to write.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskWriteTensorboardExperimentDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardExperimentName tensorboardExperiment = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]");
IEnumerable<WriteTensorboardRunDataRequest> writeRunDataRequests = new WriteTensorboardRunDataRequest[]
{
    new WriteTensorboardRunDataRequest(),
};
// Make the request
WriteTensorboardExperimentDataResponse response = await tensorboardServiceClient.WriteTensorboardExperimentDataAsync(tensorboardExperiment, writeRunDataRequests);

WriteTensorboardExperimentDataAsync(WriteTensorboardExperimentDataRequest, CallSettings)

public virtual Task<WriteTensorboardExperimentDataResponse> WriteTensorboardExperimentDataAsync(WriteTensorboardExperimentDataRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestWriteTensorboardExperimentDataRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskWriteTensorboardExperimentDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
WriteTensorboardExperimentDataRequest request = new WriteTensorboardExperimentDataRequest
{
    TensorboardExperimentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    WriteRunDataRequests =
    {
        new WriteTensorboardRunDataRequest(),
    },
};
// Make the request
WriteTensorboardExperimentDataResponse response = await tensorboardServiceClient.WriteTensorboardExperimentDataAsync(request);

WriteTensorboardExperimentDataAsync(WriteTensorboardExperimentDataRequest, CancellationToken)

public virtual Task<WriteTensorboardExperimentDataResponse> WriteTensorboardExperimentDataAsync(WriteTensorboardExperimentDataRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestWriteTensorboardExperimentDataRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskWriteTensorboardExperimentDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
WriteTensorboardExperimentDataRequest request = new WriteTensorboardExperimentDataRequest
{
    TensorboardExperimentAsTensorboardExperimentName = TensorboardExperimentName.FromProjectLocationTensorboardExperiment("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]"),
    WriteRunDataRequests =
    {
        new WriteTensorboardRunDataRequest(),
    },
};
// Make the request
WriteTensorboardExperimentDataResponse response = await tensorboardServiceClient.WriteTensorboardExperimentDataAsync(request);

WriteTensorboardExperimentDataAsync(string, IEnumerable<WriteTensorboardRunDataRequest>, CallSettings)

public virtual Task<WriteTensorboardExperimentDataResponse> WriteTensorboardExperimentDataAsync(string tensorboardExperiment, IEnumerable<WriteTensorboardRunDataRequest> writeRunDataRequests, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardExperimentstring

Required. The resource name of the TensorboardExperiment to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

writeRunDataRequestsIEnumerableWriteTensorboardRunDataRequest

Required. Requests containing per-run TensorboardTimeSeries data to write.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskWriteTensorboardExperimentDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string tensorboardExperiment = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
IEnumerable<WriteTensorboardRunDataRequest> writeRunDataRequests = new WriteTensorboardRunDataRequest[]
{
    new WriteTensorboardRunDataRequest(),
};
// Make the request
WriteTensorboardExperimentDataResponse response = await tensorboardServiceClient.WriteTensorboardExperimentDataAsync(tensorboardExperiment, writeRunDataRequests);

WriteTensorboardExperimentDataAsync(string, IEnumerable<WriteTensorboardRunDataRequest>, CancellationToken)

public virtual Task<WriteTensorboardExperimentDataResponse> WriteTensorboardExperimentDataAsync(string tensorboardExperiment, IEnumerable<WriteTensorboardRunDataRequest> writeRunDataRequests, CancellationToken cancellationToken)

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

Parameters
NameDescription
tensorboardExperimentstring

Required. The resource name of the TensorboardExperiment to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

writeRunDataRequestsIEnumerableWriteTensorboardRunDataRequest

Required. Requests containing per-run TensorboardTimeSeries data to write.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskWriteTensorboardExperimentDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string tensorboardExperiment = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]";
IEnumerable<WriteTensorboardRunDataRequest> writeRunDataRequests = new WriteTensorboardRunDataRequest[]
{
    new WriteTensorboardRunDataRequest(),
};
// Make the request
WriteTensorboardExperimentDataResponse response = await tensorboardServiceClient.WriteTensorboardExperimentDataAsync(tensorboardExperiment, writeRunDataRequests);

WriteTensorboardRunData(TensorboardRunName, IEnumerable<TimeSeriesData>, CallSettings)

public virtual WriteTensorboardRunDataResponse WriteTensorboardRunData(TensorboardRunName tensorboardRun, IEnumerable<TimeSeriesData> timeSeriesData, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardRunTensorboardRunName

Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

timeSeriesDataIEnumerableTimeSeriesData

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
WriteTensorboardRunDataResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
TensorboardRunName tensorboardRun = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
IEnumerable<TimeSeriesData> timeSeriesData = new TimeSeriesData[]
{
    new TimeSeriesData(),
};
// Make the request
WriteTensorboardRunDataResponse response = tensorboardServiceClient.WriteTensorboardRunData(tensorboardRun, timeSeriesData);

WriteTensorboardRunData(WriteTensorboardRunDataRequest, CallSettings)

public virtual WriteTensorboardRunDataResponse WriteTensorboardRunData(WriteTensorboardRunDataRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestWriteTensorboardRunDataRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
WriteTensorboardRunDataResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
WriteTensorboardRunDataRequest request = new WriteTensorboardRunDataRequest
{
    TensorboardRunAsTensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
    TimeSeriesData =
    {
        new TimeSeriesData(),
    },
};
// Make the request
WriteTensorboardRunDataResponse response = tensorboardServiceClient.WriteTensorboardRunData(request);

WriteTensorboardRunData(string, IEnumerable<TimeSeriesData>, CallSettings)

public virtual WriteTensorboardRunDataResponse WriteTensorboardRunData(string tensorboardRun, IEnumerable<TimeSeriesData> timeSeriesData, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardRunstring

Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

timeSeriesDataIEnumerableTimeSeriesData

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
WriteTensorboardRunDataResponse

The RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.Create();
// Initialize request argument(s)
string tensorboardRun = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]";
IEnumerable<TimeSeriesData> timeSeriesData = new TimeSeriesData[]
{
    new TimeSeriesData(),
};
// Make the request
WriteTensorboardRunDataResponse response = tensorboardServiceClient.WriteTensorboardRunData(tensorboardRun, timeSeriesData);

WriteTensorboardRunDataAsync(TensorboardRunName, IEnumerable<TimeSeriesData>, CallSettings)

public virtual Task<WriteTensorboardRunDataResponse> WriteTensorboardRunDataAsync(TensorboardRunName tensorboardRun, IEnumerable<TimeSeriesData> timeSeriesData, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardRunTensorboardRunName

Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

timeSeriesDataIEnumerableTimeSeriesData

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskWriteTensorboardRunDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardRunName tensorboardRun = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
IEnumerable<TimeSeriesData> timeSeriesData = new TimeSeriesData[]
{
    new TimeSeriesData(),
};
// Make the request
WriteTensorboardRunDataResponse response = await tensorboardServiceClient.WriteTensorboardRunDataAsync(tensorboardRun, timeSeriesData);

WriteTensorboardRunDataAsync(TensorboardRunName, IEnumerable<TimeSeriesData>, CancellationToken)

public virtual Task<WriteTensorboardRunDataResponse> WriteTensorboardRunDataAsync(TensorboardRunName tensorboardRun, IEnumerable<TimeSeriesData> timeSeriesData, CancellationToken cancellationToken)

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

Parameters
NameDescription
tensorboardRunTensorboardRunName

Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

timeSeriesDataIEnumerableTimeSeriesData

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskWriteTensorboardRunDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
TensorboardRunName tensorboardRun = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]");
IEnumerable<TimeSeriesData> timeSeriesData = new TimeSeriesData[]
{
    new TimeSeriesData(),
};
// Make the request
WriteTensorboardRunDataResponse response = await tensorboardServiceClient.WriteTensorboardRunDataAsync(tensorboardRun, timeSeriesData);

WriteTensorboardRunDataAsync(WriteTensorboardRunDataRequest, CallSettings)

public virtual Task<WriteTensorboardRunDataResponse> WriteTensorboardRunDataAsync(WriteTensorboardRunDataRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestWriteTensorboardRunDataRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskWriteTensorboardRunDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
WriteTensorboardRunDataRequest request = new WriteTensorboardRunDataRequest
{
    TensorboardRunAsTensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
    TimeSeriesData =
    {
        new TimeSeriesData(),
    },
};
// Make the request
WriteTensorboardRunDataResponse response = await tensorboardServiceClient.WriteTensorboardRunDataAsync(request);

WriteTensorboardRunDataAsync(WriteTensorboardRunDataRequest, CancellationToken)

public virtual Task<WriteTensorboardRunDataResponse> WriteTensorboardRunDataAsync(WriteTensorboardRunDataRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestWriteTensorboardRunDataRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskWriteTensorboardRunDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
WriteTensorboardRunDataRequest request = new WriteTensorboardRunDataRequest
{
    TensorboardRunAsTensorboardRunName = TensorboardRunName.FromProjectLocationTensorboardExperimentRun("[PROJECT]", "[LOCATION]", "[TENSORBOARD]", "[EXPERIMENT]", "[RUN]"),
    TimeSeriesData =
    {
        new TimeSeriesData(),
    },
};
// Make the request
WriteTensorboardRunDataResponse response = await tensorboardServiceClient.WriteTensorboardRunDataAsync(request);

WriteTensorboardRunDataAsync(string, IEnumerable<TimeSeriesData>, CallSettings)

public virtual Task<WriteTensorboardRunDataResponse> WriteTensorboardRunDataAsync(string tensorboardRun, IEnumerable<TimeSeriesData> timeSeriesData, CallSettings callSettings = null)

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

Parameters
NameDescription
tensorboardRunstring

Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

timeSeriesDataIEnumerableTimeSeriesData

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskWriteTensorboardRunDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string tensorboardRun = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]";
IEnumerable<TimeSeriesData> timeSeriesData = new TimeSeriesData[]
{
    new TimeSeriesData(),
};
// Make the request
WriteTensorboardRunDataResponse response = await tensorboardServiceClient.WriteTensorboardRunDataAsync(tensorboardRun, timeSeriesData);

WriteTensorboardRunDataAsync(string, IEnumerable<TimeSeriesData>, CancellationToken)

public virtual Task<WriteTensorboardRunDataResponse> WriteTensorboardRunDataAsync(string tensorboardRun, IEnumerable<TimeSeriesData> timeSeriesData, CancellationToken cancellationToken)

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

Parameters
NameDescription
tensorboardRunstring

Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

timeSeriesDataIEnumerableTimeSeriesData

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskWriteTensorboardRunDataResponse

A Task containing the RPC response.

Example
// Create client
TensorboardServiceClient tensorboardServiceClient = await TensorboardServiceClient.CreateAsync();
// Initialize request argument(s)
string tensorboardRun = "projects/[PROJECT]/locations/[LOCATION]/tensorboards/[TENSORBOARD]/experiments/[EXPERIMENT]/runs/[RUN]";
IEnumerable<TimeSeriesData> timeSeriesData = new TimeSeriesData[]
{
    new TimeSeriesData(),
};
// Make the request
WriteTensorboardRunDataResponse response = await tensorboardServiceClient.WriteTensorboardRunDataAsync(tensorboardRun, timeSeriesData);