Cloud AI Platform v1beta1 API - Class TensorboardServiceClientImpl (1.0.0-beta08) 

public sealed class TensorboardServiceClientImpl : TensorboardServiceClient

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class TensorboardServiceClientImpl.

TensorboardService client wrapper implementation, for convenient use.

Inheritance

object > TensorboardServiceClient > TensorboardServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Remarks

TensorboardService

Constructors

TensorboardServiceClientImpl(TensorboardServiceClient, TensorboardServiceSettings, ILogger)

public TensorboardServiceClientImpl(TensorboardService.TensorboardServiceClient grpcClient, TensorboardServiceSettings settings, ILogger logger)

Constructs a client wrapper for the TensorboardService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient TensorboardServiceTensorboardServiceClient

The underlying gRPC client.
settings TensorboardServiceSettings

The base TensorboardServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateTensorboardOperationsClient

public override OperationsClient CreateTensorboardOperationsClient { get; }

The long-running operations client for CreateTensorboard.

Property Value
Type Description
OperationsClient
Overrides

DeleteTensorboardExperimentOperationsClient

public override OperationsClient DeleteTensorboardExperimentOperationsClient { get; }

The long-running operations client for DeleteTensorboardExperiment.

Property Value
Type Description
OperationsClient
Overrides

DeleteTensorboardOperationsClient

public override OperationsClient DeleteTensorboardOperationsClient { get; }

The long-running operations client for DeleteTensorboard.

Property Value
Type Description
OperationsClient
Overrides

DeleteTensorboardRunOperationsClient

public override OperationsClient DeleteTensorboardRunOperationsClient { get; }

The long-running operations client for DeleteTensorboardRun.

Property Value
Type Description
OperationsClient
Overrides

DeleteTensorboardTimeSeriesOperationsClient

public override OperationsClient DeleteTensorboardTimeSeriesOperationsClient { get; }

The long-running operations client for DeleteTensorboardTimeSeries.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override TensorboardService.TensorboardServiceClient GrpcClient { get; }

The underlying gRPC TensorboardService client

Property Value
Type Description
TensorboardServiceTensorboardServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateTensorboardOperationsClient

public override OperationsClient UpdateTensorboardOperationsClient { get; }

The long-running operations client for UpdateTensorboard.

Property Value
Type Description
OperationsClient
Overrides

Methods

BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest, CallSettings)

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

Batch create TensorboardRuns.

Parameters
Name Description
request BatchCreateTensorboardRunsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchCreateTensorboardRunsResponse

The RPC response.
Overrides

BatchCreateTensorboardRunsAsync(BatchCreateTensorboardRunsRequest, CallSettings)

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

Batch create TensorboardRuns.

Parameters
Name Description
request BatchCreateTensorboardRunsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskBatchCreateTensorboardRunsResponse

A Task containing the RPC response.
Overrides

BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest, CallSettings)

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

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
Name Description
request BatchCreateTensorboardTimeSeriesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchCreateTensorboardTimeSeriesResponse

The RPC response.
Overrides

BatchCreateTensorboardTimeSeriesAsync(BatchCreateTensorboardTimeSeriesRequest, CallSettings)

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

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters
Name Description
request BatchCreateTensorboardTimeSeriesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskBatchCreateTensorboardTimeSeriesResponse

A Task containing the RPC response.
Overrides

BatchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest, CallSettings)

public override 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
Name Description
request BatchReadTensorboardTimeSeriesDataRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchReadTensorboardTimeSeriesDataResponse

The RPC response.
Overrides

BatchReadTensorboardTimeSeriesDataAsync(BatchReadTensorboardTimeSeriesDataRequest, CallSettings)

public override 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
Name Description
request BatchReadTensorboardTimeSeriesDataRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskBatchReadTensorboardTimeSeriesDataResponse

A Task containing the RPC response.
Overrides

CreateTensorboard(CreateTensorboardRequest, CallSettings)

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

Creates a Tensorboard.

Parameters
Name Description
request CreateTensorboardRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationTensorboardCreateTensorboardOperationMetadata

The RPC response.
Overrides

CreateTensorboardAsync(CreateTensorboardRequest, CallSettings)

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

Creates a Tensorboard.

Parameters
Name Description
request CreateTensorboardRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationTensorboardCreateTensorboardOperationMetadata

A Task containing the RPC response.
Overrides

CreateTensorboardExperiment(CreateTensorboardExperimentRequest, CallSettings)

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

Creates a TensorboardExperiment.

Parameters
Name Description
request CreateTensorboardExperimentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TensorboardExperiment

The RPC response.
Overrides

CreateTensorboardExperimentAsync(CreateTensorboardExperimentRequest, CallSettings)

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

Creates a TensorboardExperiment.

Parameters
Name Description
request CreateTensorboardExperimentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTensorboardExperiment

A Task containing the RPC response.
Overrides

CreateTensorboardRun(CreateTensorboardRunRequest, CallSettings)

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

Creates a TensorboardRun.

Parameters
Name Description
request CreateTensorboardRunRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TensorboardRun

The RPC response.
Overrides

CreateTensorboardRunAsync(CreateTensorboardRunRequest, CallSettings)

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

Creates a TensorboardRun.

Parameters
Name Description
request CreateTensorboardRunRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTensorboardRun

A Task containing the RPC response.
Overrides

CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest, CallSettings)

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

Creates a TensorboardTimeSeries.

Parameters
Name Description
request CreateTensorboardTimeSeriesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TensorboardTimeSeries

The RPC response.
Overrides

CreateTensorboardTimeSeriesAsync(CreateTensorboardTimeSeriesRequest, CallSettings)

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

Creates a TensorboardTimeSeries.

Parameters
Name Description
request CreateTensorboardTimeSeriesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTensorboardTimeSeries

A Task containing the RPC response.
Overrides

DeleteTensorboard(DeleteTensorboardRequest, CallSettings)

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

Deletes a Tensorboard.

Parameters
Name Description
request DeleteTensorboardRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteTensorboardAsync(DeleteTensorboardRequest, CallSettings)

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

Deletes a Tensorboard.

Parameters
Name Description
request DeleteTensorboardRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest, CallSettings)

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

Deletes a TensorboardExperiment.

Parameters
Name Description
request DeleteTensorboardExperimentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteTensorboardExperimentAsync(DeleteTensorboardExperimentRequest, CallSettings)

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

Deletes a TensorboardExperiment.

Parameters
Name Description
request DeleteTensorboardExperimentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteTensorboardRun(DeleteTensorboardRunRequest, CallSettings)

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

Deletes a TensorboardRun.

Parameters
Name Description
request DeleteTensorboardRunRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteTensorboardRunAsync(DeleteTensorboardRunRequest, CallSettings)

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

Deletes a TensorboardRun.

Parameters
Name Description
request DeleteTensorboardRunRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest, CallSettings)

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

Deletes a TensorboardTimeSeries.

Parameters
Name Description
request DeleteTensorboardTimeSeriesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteTensorboardTimeSeriesAsync(DeleteTensorboardTimeSeriesRequest, CallSettings)

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

Deletes a TensorboardTimeSeries.

Parameters
Name Description
request DeleteTensorboardTimeSeriesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

ExportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest, CallSettings)

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

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

Parameters
Name Description
request ExportTensorboardTimeSeriesDataRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableExportTensorboardTimeSeriesDataResponseTimeSeriesDataPoint

A pageable sequence of TimeSeriesDataPoint resources.
Overrides

ExportTensorboardTimeSeriesDataAsync(ExportTensorboardTimeSeriesDataRequest, CallSettings)

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

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

Parameters
Name Description
request ExportTensorboardTimeSeriesDataRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableExportTensorboardTimeSeriesDataResponseTimeSeriesDataPoint

A pageable asynchronous sequence of TimeSeriesDataPoint resources.
Overrides

GetTensorboard(GetTensorboardRequest, CallSettings)

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

Gets a Tensorboard.

Parameters
Name Description
request GetTensorboardRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Tensorboard

The RPC response.
Overrides

GetTensorboardAsync(GetTensorboardRequest, CallSettings)

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

Gets a Tensorboard.

Parameters
Name Description
request GetTensorboardRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTensorboard

A Task containing the RPC response.
Overrides

GetTensorboardExperiment(GetTensorboardExperimentRequest, CallSettings)

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

Gets a TensorboardExperiment.

Parameters
Name Description
request GetTensorboardExperimentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TensorboardExperiment

The RPC response.
Overrides

GetTensorboardExperimentAsync(GetTensorboardExperimentRequest, CallSettings)

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

Gets a TensorboardExperiment.

Parameters
Name Description
request GetTensorboardExperimentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTensorboardExperiment

A Task containing the RPC response.
Overrides

GetTensorboardRun(GetTensorboardRunRequest, CallSettings)

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

Gets a TensorboardRun.

Parameters
Name Description
request GetTensorboardRunRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TensorboardRun

The RPC response.
Overrides

GetTensorboardRunAsync(GetTensorboardRunRequest, CallSettings)

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

Gets a TensorboardRun.

Parameters
Name Description
request GetTensorboardRunRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTensorboardRun

A Task containing the RPC response.
Overrides

GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest, CallSettings)

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

Gets a TensorboardTimeSeries.

Parameters
Name Description
request GetTensorboardTimeSeriesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TensorboardTimeSeries

The RPC response.
Overrides

GetTensorboardTimeSeriesAsync(GetTensorboardTimeSeriesRequest, CallSettings)

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

Gets a TensorboardTimeSeries.

Parameters
Name Description
request GetTensorboardTimeSeriesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTensorboardTimeSeries

A Task containing the RPC response.
Overrides

ListTensorboardExperiments(ListTensorboardExperimentsRequest, CallSettings)

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

Lists TensorboardExperiments in a Location.

Parameters
Name Description
request ListTensorboardExperimentsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTensorboardExperimentsResponseTensorboardExperiment

A pageable sequence of TensorboardExperiment resources.
Overrides

ListTensorboardExperimentsAsync(ListTensorboardExperimentsRequest, CallSettings)

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

Lists TensorboardExperiments in a Location.

Parameters
Name Description
request ListTensorboardExperimentsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTensorboardExperimentsResponseTensorboardExperiment

A pageable asynchronous sequence of TensorboardExperiment resources.
Overrides

ListTensorboardRuns(ListTensorboardRunsRequest, CallSettings)

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

Lists TensorboardRuns in a Location.

Parameters
Name Description
request ListTensorboardRunsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTensorboardRunsResponseTensorboardRun

A pageable sequence of TensorboardRun resources.
Overrides

ListTensorboardRunsAsync(ListTensorboardRunsRequest, CallSettings)

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

Lists TensorboardRuns in a Location.

Parameters
Name Description
request ListTensorboardRunsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTensorboardRunsResponseTensorboardRun

A pageable asynchronous sequence of TensorboardRun resources.
Overrides

ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest, CallSettings)

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

Lists TensorboardTimeSeries in a Location.

Parameters
Name Description
request ListTensorboardTimeSeriesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTensorboardTimeSeriesResponseTensorboardTimeSeries

A pageable sequence of TensorboardTimeSeries resources.
Overrides

ListTensorboardTimeSeriesAsync(ListTensorboardTimeSeriesRequest, CallSettings)

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

Lists TensorboardTimeSeries in a Location.

Parameters
Name Description
request ListTensorboardTimeSeriesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTensorboardTimeSeriesResponseTensorboardTimeSeries

A pageable asynchronous sequence of TensorboardTimeSeries resources.
Overrides

ListTensorboards(ListTensorboardsRequest, CallSettings)

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

Lists Tensorboards in a Location.

Parameters
Name Description
request ListTensorboardsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTensorboardsResponseTensorboard

A pageable sequence of Tensorboard resources.
Overrides

ListTensorboardsAsync(ListTensorboardsRequest, CallSettings)

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

Lists Tensorboards in a Location.

Parameters
Name Description
request ListTensorboardsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTensorboardsResponseTensorboard

A pageable asynchronous sequence of Tensorboard resources.
Overrides

ReadTensorboardBlobData(ReadTensorboardBlobDataRequest, CallSettings)

public override 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
Name Description
request ReadTensorboardBlobDataRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TensorboardServiceClientReadTensorboardBlobDataStream

The server stream.
Overrides

ReadTensorboardSize(ReadTensorboardSizeRequest, CallSettings)

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

Returns the storage size for a given TensorBoard instance.

Parameters
Name Description
request ReadTensorboardSizeRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
ReadTensorboardSizeResponse

The RPC response.
Overrides

ReadTensorboardSizeAsync(ReadTensorboardSizeRequest, CallSettings)

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

Returns the storage size for a given TensorBoard instance.

Parameters
Name Description
request ReadTensorboardSizeRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskReadTensorboardSizeResponse

A Task containing the RPC response.
Overrides

ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest, CallSettings)

public override 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
Name Description
request ReadTensorboardTimeSeriesDataRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
ReadTensorboardTimeSeriesDataResponse

The RPC response.
Overrides

ReadTensorboardTimeSeriesDataAsync(ReadTensorboardTimeSeriesDataRequest, CallSettings)

public override 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
Name Description
request ReadTensorboardTimeSeriesDataRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskReadTensorboardTimeSeriesDataResponse

A Task containing the RPC response.
Overrides

ReadTensorboardUsage(ReadTensorboardUsageRequest, CallSettings)

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

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

Parameters
Name Description
request ReadTensorboardUsageRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
ReadTensorboardUsageResponse

The RPC response.
Overrides

ReadTensorboardUsageAsync(ReadTensorboardUsageRequest, CallSettings)

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

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

Parameters
Name Description
request ReadTensorboardUsageRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskReadTensorboardUsageResponse

A Task containing the RPC response.
Overrides

UpdateTensorboard(UpdateTensorboardRequest, CallSettings)

public override Operation<Tensorboard, UpdateTensorboardOperationMetadata> UpdateTensorboard(UpdateTensorboardRequest request, CallSettings callSettings = null)

Updates a Tensorboard.

Parameters
Name Description
request UpdateTensorboardRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationTensorboardUpdateTensorboardOperationMetadata

The RPC response.
Overrides

UpdateTensorboardAsync(UpdateTensorboardRequest, CallSettings)

public override Task<Operation<Tensorboard, UpdateTensorboardOperationMetadata>> UpdateTensorboardAsync(UpdateTensorboardRequest request, CallSettings callSettings = null)

Updates a Tensorboard.

Parameters
Name Description
request UpdateTensorboardRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationTensorboardUpdateTensorboardOperationMetadata

A Task containing the RPC response.
Overrides

UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest, CallSettings)

public override TensorboardExperiment UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest request, CallSettings callSettings = null)

Updates a TensorboardExperiment.

Parameters
Name Description
request UpdateTensorboardExperimentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TensorboardExperiment

The RPC response.
Overrides

UpdateTensorboardExperimentAsync(UpdateTensorboardExperimentRequest, CallSettings)

public override Task<TensorboardExperiment> UpdateTensorboardExperimentAsync(UpdateTensorboardExperimentRequest request, CallSettings callSettings = null)

Updates a TensorboardExperiment.

Parameters
Name Description
request UpdateTensorboardExperimentRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTensorboardExperiment

A Task containing the RPC response.
Overrides

UpdateTensorboardRun(UpdateTensorboardRunRequest, CallSettings)

public override TensorboardRun UpdateTensorboardRun(UpdateTensorboardRunRequest request, CallSettings callSettings = null)

Updates a TensorboardRun.

Parameters
Name Description
request UpdateTensorboardRunRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TensorboardRun

The RPC response.
Overrides

UpdateTensorboardRunAsync(UpdateTensorboardRunRequest, CallSettings)

public override Task<TensorboardRun> UpdateTensorboardRunAsync(UpdateTensorboardRunRequest request, CallSettings callSettings = null)

Updates a TensorboardRun.

Parameters
Name Description
request UpdateTensorboardRunRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTensorboardRun

A Task containing the RPC response.
Overrides

UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest, CallSettings)

public override TensorboardTimeSeries UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Updates a TensorboardTimeSeries.

Parameters
Name Description
request UpdateTensorboardTimeSeriesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TensorboardTimeSeries

The RPC response.
Overrides

UpdateTensorboardTimeSeriesAsync(UpdateTensorboardTimeSeriesRequest, CallSettings)

public override Task<TensorboardTimeSeries> UpdateTensorboardTimeSeriesAsync(UpdateTensorboardTimeSeriesRequest request, CallSettings callSettings = null)

Updates a TensorboardTimeSeries.

Parameters
Name Description
request UpdateTensorboardTimeSeriesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTensorboardTimeSeries

A Task containing the RPC response.
Overrides

WriteTensorboardExperimentData(WriteTensorboardExperimentDataRequest, CallSettings)

public override 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
Name Description
request WriteTensorboardExperimentDataRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
WriteTensorboardExperimentDataResponse

The RPC response.
Overrides

WriteTensorboardExperimentDataAsync(WriteTensorboardExperimentDataRequest, CallSettings)

public override 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
Name Description
request WriteTensorboardExperimentDataRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskWriteTensorboardExperimentDataResponse

A Task containing the RPC response.
Overrides

WriteTensorboardRunData(WriteTensorboardRunDataRequest, CallSettings)

public override 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
Name Description
request WriteTensorboardRunDataRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
WriteTensorboardRunDataResponse

The RPC response.
Overrides

WriteTensorboardRunDataAsync(WriteTensorboardRunDataRequest, CallSettings)

public override 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
Name Description
request WriteTensorboardRunDataRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskWriteTensorboardRunDataResponse

A Task containing the RPC response.
Overrides