Cloud AI Platform v1 API - Class TensorboardServiceClientImpl (2.12.0) 

public sealed class TensorboardServiceClientImpl : TensorboardServiceClient

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

TensorboardService client wrapper implementation, for convenient use.

Inheritance

object > TensorboardServiceClient > TensorboardServiceClientImpl

Namespace

GoogleCloudGoogle.Cloud.AIPlatformV1

Assembly

Google.Cloud.AIPlatform.V1.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
NameDescription
grpcClientTensorboardServiceTensorboardServiceClient

The underlying gRPC client.

settingsTensorboardServiceSettings

The base TensorboardServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CreateTensorboardOperationsClient

public override OperationsClient CreateTensorboardOperationsClient { get; }

The long-running operations client for CreateTensorboard.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteTensorboardExperimentOperationsClient

public override OperationsClient DeleteTensorboardExperimentOperationsClient { get; }

The long-running operations client for DeleteTensorboardExperiment.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteTensorboardOperationsClient

public override OperationsClient DeleteTensorboardOperationsClient { get; }

The long-running operations client for DeleteTensorboard.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteTensorboardRunOperationsClient

public override OperationsClient DeleteTensorboardRunOperationsClient { get; }

The long-running operations client for DeleteTensorboardRun.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteTensorboardTimeSeriesOperationsClient

public override OperationsClient DeleteTensorboardTimeSeriesOperationsClient { get; }

The long-running operations client for DeleteTensorboardTimeSeries.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override TensorboardService.TensorboardServiceClient GrpcClient { get; }

The underlying gRPC TensorboardService client

Property Value
TypeDescription
TensorboardServiceTensorboardServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

UpdateTensorboardOperationsClient

public override OperationsClient UpdateTensorboardOperationsClient { get; }

The long-running operations client for UpdateTensorboard.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest, CallSettings)

public override 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.

Overrides

BatchCreateTensorboardRunsAsync(BatchCreateTensorboardRunsRequest, CallSettings)

public override 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.

Overrides

BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest, CallSettings)

public override 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.

Overrides

BatchCreateTensorboardTimeSeriesAsync(BatchCreateTensorboardTimeSeriesRequest, CallSettings)

public override 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.

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
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.

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
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.

Overrides

CreateTensorboard(CreateTensorboardRequest, CallSettings)

public override 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.

Overrides

CreateTensorboardAsync(CreateTensorboardRequest, CallSettings)

public override 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.

Overrides

CreateTensorboardExperiment(CreateTensorboardExperimentRequest, CallSettings)

public override 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.

Overrides

CreateTensorboardExperimentAsync(CreateTensorboardExperimentRequest, CallSettings)

public override 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.

Overrides

CreateTensorboardRun(CreateTensorboardRunRequest, CallSettings)

public override 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.

Overrides

CreateTensorboardRunAsync(CreateTensorboardRunRequest, CallSettings)

public override 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.

Overrides

CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest, CallSettings)

public override 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.

Overrides

CreateTensorboardTimeSeriesAsync(CreateTensorboardTimeSeriesRequest, CallSettings)

public override 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.

Overrides

DeleteTensorboard(DeleteTensorboardRequest, CallSettings)

public override 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.

Overrides

DeleteTensorboardAsync(DeleteTensorboardRequest, CallSettings)

public override 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.

Overrides

DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest, CallSettings)

public override 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.

Overrides

DeleteTensorboardExperimentAsync(DeleteTensorboardExperimentRequest, CallSettings)

public override 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.

Overrides

DeleteTensorboardRun(DeleteTensorboardRunRequest, CallSettings)

public override 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.

Overrides

DeleteTensorboardRunAsync(DeleteTensorboardRunRequest, CallSettings)

public override 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.

Overrides

DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest, CallSettings)

public override 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.

Overrides

DeleteTensorboardTimeSeriesAsync(DeleteTensorboardTimeSeriesRequest, CallSettings)

public override 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.

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
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.

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
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.

Overrides

GetTensorboard(GetTensorboardRequest, CallSettings)

public override 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.

Overrides

GetTensorboardAsync(GetTensorboardRequest, CallSettings)

public override 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.

Overrides

GetTensorboardExperiment(GetTensorboardExperimentRequest, CallSettings)

public override 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.

Overrides

GetTensorboardExperimentAsync(GetTensorboardExperimentRequest, CallSettings)

public override 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.

Overrides

GetTensorboardRun(GetTensorboardRunRequest, CallSettings)

public override 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.

Overrides

GetTensorboardRunAsync(GetTensorboardRunRequest, CallSettings)

public override 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.

Overrides

GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest, CallSettings)

public override 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.

Overrides

GetTensorboardTimeSeriesAsync(GetTensorboardTimeSeriesRequest, CallSettings)

public override 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.

Overrides

ListTensorboardExperiments(ListTensorboardExperimentsRequest, CallSettings)

public override 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.

Overrides

ListTensorboardExperimentsAsync(ListTensorboardExperimentsRequest, CallSettings)

public override 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.

Overrides

ListTensorboardRuns(ListTensorboardRunsRequest, CallSettings)

public override 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.

Overrides

ListTensorboardRunsAsync(ListTensorboardRunsRequest, CallSettings)

public override 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.

Overrides

ListTensorboards(ListTensorboardsRequest, CallSettings)

public override 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.

Overrides

ListTensorboardsAsync(ListTensorboardsRequest, CallSettings)

public override 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.

Overrides

ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest, CallSettings)

public override 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.

Overrides

ListTensorboardTimeSeriesAsync(ListTensorboardTimeSeriesRequest, CallSettings)

public override 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.

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
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.

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
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.

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
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.

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
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.

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
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.

Overrides

UpdateTensorboard(UpdateTensorboardRequest, CallSettings)

public override 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.

Overrides

UpdateTensorboardAsync(UpdateTensorboardRequest, CallSettings)

public override 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.

Overrides

UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest, CallSettings)

public override 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.

Overrides

UpdateTensorboardExperimentAsync(UpdateTensorboardExperimentRequest, CallSettings)

public override 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.

Overrides

UpdateTensorboardRun(UpdateTensorboardRunRequest, CallSettings)

public override 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.

Overrides

UpdateTensorboardRunAsync(UpdateTensorboardRunRequest, CallSettings)

public override 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.

Overrides

UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest, CallSettings)

public override 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.

Overrides

UpdateTensorboardTimeSeriesAsync(UpdateTensorboardTimeSeriesRequest, CallSettings)

public override 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.

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
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.

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
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.

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
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.

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
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.

Overrides