TensorboardService.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
TensorboardServiceClient(TensorboardServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TensorboardServiceClient const &
|
TensorboardServiceClient(TensorboardServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TensorboardServiceClient &&
|
TensorboardServiceClient(std::shared_ptr< TensorboardServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< TensorboardServiceConnection >
|
opts |
Options
|
Operators
operator=(TensorboardServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TensorboardServiceClient const &
|
Returns | |
---|---|
Type | Description |
TensorboardServiceClient & |
operator=(TensorboardServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TensorboardServiceClient &&
|
Returns | |
---|---|
Type | Description |
TensorboardServiceClient & |
Functions
CreateTensorboard(std::string const &, google::cloud::aiplatform::v1::Tensorboard const &, Options)
Creates a Tensorboard.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to create the Tensorboard in. Format: |
tensorboard |
google::cloud::aiplatform::v1::Tensorboard const &
Required. The Tensorboard to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::Tensorboard > > |
A |
CreateTensorboard(NoAwaitTag, std::string const &, google::cloud::aiplatform::v1::Tensorboard const &, Options)
Creates a Tensorboard.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
tensorboard |
google::cloud::aiplatform::v1::Tensorboard const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateTensorboard(google::cloud::aiplatform::v1::CreateTensorboardRequest const &, Options)
Creates a Tensorboard.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateTensorboardRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::Tensorboard > > |
A |
CreateTensorboard(NoAwaitTag, google::cloud::aiplatform::v1::CreateTensorboardRequest const &, Options)
Creates a Tensorboard.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::aiplatform::v1::CreateTensorboardRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateTensorboard(google::longrunning::Operation const &, Options)
Creates a Tensorboard.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::Tensorboard > > |
GetTensorboard(std::string const &, Options)
Gets a Tensorboard.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Tensorboard resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Tensorboard > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Tensorboard) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTensorboard(google::cloud::aiplatform::v1::GetTensorboardRequest const &, Options)
Gets a Tensorboard.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetTensorboardRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::Tensorboard > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.Tensorboard) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateTensorboard(google::cloud::aiplatform::v1::Tensorboard const &, google::protobuf::FieldMask const &, Options)
Updates a Tensorboard.
Parameters | |
---|---|
Name | Description |
tensorboard |
google::cloud::aiplatform::v1::Tensorboard const &
Required. The Tensorboard's |
update_mask |
google::protobuf::FieldMask const &
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. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::Tensorboard > > |
A |
UpdateTensorboard(NoAwaitTag, google::cloud::aiplatform::v1::Tensorboard const &, google::protobuf::FieldMask const &, Options)
Updates a Tensorboard.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
tensorboard |
google::cloud::aiplatform::v1::Tensorboard const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateTensorboard(google::cloud::aiplatform::v1::UpdateTensorboardRequest const &, Options)
Updates a Tensorboard.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::UpdateTensorboardRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::Tensorboard > > |
A |
UpdateTensorboard(NoAwaitTag, google::cloud::aiplatform::v1::UpdateTensorboardRequest const &, Options)
Updates a Tensorboard.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::aiplatform::v1::UpdateTensorboardRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateTensorboard(google::longrunning::Operation const &, Options)
Updates a Tensorboard.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::Tensorboard > > |
ListTensorboards(std::string const &, Options)
Lists Tensorboards in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to list Tensorboards. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::Tensorboard > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListTensorboards(google::cloud::aiplatform::v1::ListTensorboardsRequest, Options)
Lists Tensorboards in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListTensorboardsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::Tensorboard > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteTensorboard(std::string const &, Options)
Deletes a Tensorboard.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Tensorboard to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteTensorboard(NoAwaitTag, std::string const &, Options)
Deletes a Tensorboard.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteTensorboard(google::cloud::aiplatform::v1::DeleteTensorboardRequest const &, Options)
Deletes a Tensorboard.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteTensorboardRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteTensorboard(NoAwaitTag, google::cloud::aiplatform::v1::DeleteTensorboardRequest const &, Options)
Deletes a Tensorboard.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::aiplatform::v1::DeleteTensorboardRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteTensorboard(google::longrunning::Operation const &, Options)
Deletes a Tensorboard.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
ReadTensorboardUsage(std::string const &, Options)
Returns a list of monthly active users for a given TensorBoard instance.
Parameters | |
---|---|
Name | Description |
tensorboard |
std::string const &
Required. The name of the Tensorboard resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::ReadTensorboardUsageResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ReadTensorboardUsageResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ReadTensorboardUsage(google::cloud::aiplatform::v1::ReadTensorboardUsageRequest const &, Options)
Returns a list of monthly active users for a given TensorBoard instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ReadTensorboardUsageRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::ReadTensorboardUsageResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ReadTensorboardUsageResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ReadTensorboardSize(std::string const &, Options)
Returns the storage size for a given TensorBoard instance.
Parameters | |
---|---|
Name | Description |
tensorboard |
std::string const &
Required. The name of the Tensorboard resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::ReadTensorboardSizeResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ReadTensorboardSizeResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ReadTensorboardSize(google::cloud::aiplatform::v1::ReadTensorboardSizeRequest const &, Options)
Returns the storage size for a given TensorBoard instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ReadTensorboardSizeRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::ReadTensorboardSizeResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ReadTensorboardSizeResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateTensorboardExperiment(std::string const &, google::cloud::aiplatform::v1::TensorboardExperiment const &, std::string const &, Options)
Creates a TensorboardExperiment.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: |
tensorboard_experiment |
google::cloud::aiplatform::v1::TensorboardExperiment const &
The TensorboardExperiment to create. |
tensorboard_experiment_id |
std::string const &
Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardExperiment > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardExperiment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateTensorboardExperiment(google::cloud::aiplatform::v1::CreateTensorboardExperimentRequest const &, Options)
Creates a TensorboardExperiment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateTensorboardExperimentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardExperiment > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardExperiment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTensorboardExperiment(std::string const &, Options)
Gets a TensorboardExperiment.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the TensorboardExperiment resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardExperiment > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardExperiment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTensorboardExperiment(google::cloud::aiplatform::v1::GetTensorboardExperimentRequest const &, Options)
Gets a TensorboardExperiment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetTensorboardExperimentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardExperiment > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardExperiment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateTensorboardExperiment(google::cloud::aiplatform::v1::TensorboardExperiment const &, google::protobuf::FieldMask const &, Options)
Updates a TensorboardExperiment.
Parameters | |
---|---|
Name | Description |
tensorboard_experiment |
google::cloud::aiplatform::v1::TensorboardExperiment const &
Required. The TensorboardExperiment's |
update_mask |
google::protobuf::FieldMask const &
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. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardExperiment > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardExperiment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateTensorboardExperiment(google::cloud::aiplatform::v1::UpdateTensorboardExperimentRequest const &, Options)
Updates a TensorboardExperiment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::UpdateTensorboardExperimentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardExperiment > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardExperiment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListTensorboardExperiments(std::string const &, Options)
Lists TensorboardExperiments in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::TensorboardExperiment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListTensorboardExperiments(google::cloud::aiplatform::v1::ListTensorboardExperimentsRequest, Options)
Lists TensorboardExperiments in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListTensorboardExperimentsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::TensorboardExperiment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteTensorboardExperiment(std::string const &, Options)
Deletes a TensorboardExperiment.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the TensorboardExperiment to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteTensorboardExperiment(NoAwaitTag, std::string const &, Options)
Deletes a TensorboardExperiment.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteTensorboardExperiment(google::cloud::aiplatform::v1::DeleteTensorboardExperimentRequest const &, Options)
Deletes a TensorboardExperiment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteTensorboardExperimentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteTensorboardExperiment(NoAwaitTag, google::cloud::aiplatform::v1::DeleteTensorboardExperimentRequest const &, Options)
Deletes a TensorboardExperiment.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::aiplatform::v1::DeleteTensorboardExperimentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteTensorboardExperiment(google::longrunning::Operation const &, Options)
Deletes a TensorboardExperiment.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
CreateTensorboardRun(std::string const &, google::cloud::aiplatform::v1::TensorboardRun const &, std::string const &, Options)
Creates a TensorboardRun.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: |
tensorboard_run |
google::cloud::aiplatform::v1::TensorboardRun const &
Required. The TensorboardRun to create. |
tensorboard_run_id |
std::string const &
Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardRun > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateTensorboardRun(google::cloud::aiplatform::v1::CreateTensorboardRunRequest const &, Options)
Creates a TensorboardRun.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateTensorboardRunRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardRun > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
BatchCreateTensorboardRuns(std::string const &, std::vector< google::cloud::aiplatform::v1::CreateTensorboardRunRequest > const &, Options)
Batch create TensorboardRuns.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: |
requests |
std::vector< google::cloud::aiplatform::v1::CreateTensorboardRunRequest > const &
Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::BatchCreateTensorboardRunsResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.BatchCreateTensorboardRunsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
BatchCreateTensorboardRuns(google::cloud::aiplatform::v1::BatchCreateTensorboardRunsRequest const &, Options)
Batch create TensorboardRuns.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::BatchCreateTensorboardRunsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::BatchCreateTensorboardRunsResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.BatchCreateTensorboardRunsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTensorboardRun(std::string const &, Options)
Gets a TensorboardRun.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the TensorboardRun resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardRun > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTensorboardRun(google::cloud::aiplatform::v1::GetTensorboardRunRequest const &, Options)
Gets a TensorboardRun.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetTensorboardRunRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardRun > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateTensorboardRun(google::cloud::aiplatform::v1::TensorboardRun const &, google::protobuf::FieldMask const &, Options)
Updates a TensorboardRun.
Parameters | |
---|---|
Name | Description |
tensorboard_run |
google::cloud::aiplatform::v1::TensorboardRun const &
Required. The TensorboardRun's |
update_mask |
google::protobuf::FieldMask const &
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. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardRun > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateTensorboardRun(google::cloud::aiplatform::v1::UpdateTensorboardRunRequest const &, Options)
Updates a TensorboardRun.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::UpdateTensorboardRunRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardRun > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListTensorboardRuns(std::string const &, Options)
Lists TensorboardRuns in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::TensorboardRun > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListTensorboardRuns(google::cloud::aiplatform::v1::ListTensorboardRunsRequest, Options)
Lists TensorboardRuns in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListTensorboardRunsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::TensorboardRun > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteTensorboardRun(std::string const &, Options)
Deletes a TensorboardRun.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the TensorboardRun to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteTensorboardRun(NoAwaitTag, std::string const &, Options)
Deletes a TensorboardRun.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteTensorboardRun(google::cloud::aiplatform::v1::DeleteTensorboardRunRequest const &, Options)
Deletes a TensorboardRun.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteTensorboardRunRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteTensorboardRun(NoAwaitTag, google::cloud::aiplatform::v1::DeleteTensorboardRunRequest const &, Options)
Deletes a TensorboardRun.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::aiplatform::v1::DeleteTensorboardRunRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteTensorboardRun(google::longrunning::Operation const &, Options)
Deletes a TensorboardRun.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
BatchCreateTensorboardTimeSeries(std::string const &, std::vector< google::cloud::aiplatform::v1::CreateTensorboardTimeSeriesRequest > const &, Options)
Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: |
requests |
std::vector< google::cloud::aiplatform::v1::CreateTensorboardTimeSeriesRequest > const &
Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::BatchCreateTensorboardTimeSeriesResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.BatchCreateTensorboardTimeSeriesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
BatchCreateTensorboardTimeSeries(google::cloud::aiplatform::v1::BatchCreateTensorboardTimeSeriesRequest const &, Options)
Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::BatchCreateTensorboardTimeSeriesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::BatchCreateTensorboardTimeSeriesResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.BatchCreateTensorboardTimeSeriesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateTensorboardTimeSeries(std::string const &, google::cloud::aiplatform::v1::TensorboardTimeSeries const &, Options)
Creates a TensorboardTimeSeries.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: |
tensorboard_time_series |
google::cloud::aiplatform::v1::TensorboardTimeSeries const &
Required. The TensorboardTimeSeries to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardTimeSeries > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardTimeSeries) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateTensorboardTimeSeries(google::cloud::aiplatform::v1::CreateTensorboardTimeSeriesRequest const &, Options)
Creates a TensorboardTimeSeries.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateTensorboardTimeSeriesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardTimeSeries > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardTimeSeries) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTensorboardTimeSeries(std::string const &, Options)
Gets a TensorboardTimeSeries.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the TensorboardTimeSeries resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardTimeSeries > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardTimeSeries) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTensorboardTimeSeries(google::cloud::aiplatform::v1::GetTensorboardTimeSeriesRequest const &, Options)
Gets a TensorboardTimeSeries.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetTensorboardTimeSeriesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardTimeSeries > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardTimeSeries) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateTensorboardTimeSeries(google::cloud::aiplatform::v1::TensorboardTimeSeries const &, google::protobuf::FieldMask const &, Options)
Updates a TensorboardTimeSeries.
Parameters | |
---|---|
Name | Description |
tensorboard_time_series |
google::cloud::aiplatform::v1::TensorboardTimeSeries const &
Required. The TensorboardTimeSeries' |
update_mask |
google::protobuf::FieldMask const &
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. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardTimeSeries > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardTimeSeries) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateTensorboardTimeSeries(google::cloud::aiplatform::v1::UpdateTensorboardTimeSeriesRequest const &, Options)
Updates a TensorboardTimeSeries.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::UpdateTensorboardTimeSeriesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::TensorboardTimeSeries > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.TensorboardTimeSeries) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListTensorboardTimeSeries(std::string const &, Options)
Lists TensorboardTimeSeries in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::TensorboardTimeSeries > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListTensorboardTimeSeries(google::cloud::aiplatform::v1::ListTensorboardTimeSeriesRequest, Options)
Lists TensorboardTimeSeries in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListTensorboardTimeSeriesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::TensorboardTimeSeries > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteTensorboardTimeSeries(std::string const &, Options)
Deletes a TensorboardTimeSeries.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the TensorboardTimeSeries to be deleted. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteTensorboardTimeSeries(NoAwaitTag, std::string const &, Options)
Deletes a TensorboardTimeSeries.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteTensorboardTimeSeries(google::cloud::aiplatform::v1::DeleteTensorboardTimeSeriesRequest const &, Options)
Deletes a TensorboardTimeSeries.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteTensorboardTimeSeriesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
A |
DeleteTensorboardTimeSeries(NoAwaitTag, google::cloud::aiplatform::v1::DeleteTensorboardTimeSeriesRequest const &, Options)
Deletes a TensorboardTimeSeries.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::aiplatform::v1::DeleteTensorboardTimeSeriesRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteTensorboardTimeSeries(google::longrunning::Operation const &, Options)
Deletes a TensorboardTimeSeries.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > > |
BatchReadTensorboardTimeSeriesData(std::string const &, Options)
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 |
tensorboard |
std::string const &
Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::BatchReadTensorboardTimeSeriesDataResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
BatchReadTensorboardTimeSeriesData(google::cloud::aiplatform::v1::BatchReadTensorboardTimeSeriesDataRequest const &, Options)
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 |
google::cloud::aiplatform::v1::BatchReadTensorboardTimeSeriesDataRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::BatchReadTensorboardTimeSeriesDataResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ReadTensorboardTimeSeriesData(std::string const &, Options)
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 |
tensorboard_time_series |
std::string const &
Required. The resource name of the TensorboardTimeSeries to read data from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::ReadTensorboardTimeSeriesDataResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ReadTensorboardTimeSeriesDataResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ReadTensorboardTimeSeriesData(google::cloud::aiplatform::v1::ReadTensorboardTimeSeriesDataRequest const &, Options)
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 |
google::cloud::aiplatform::v1::ReadTensorboardTimeSeriesDataRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::ReadTensorboardTimeSeriesDataResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ReadTensorboardTimeSeriesDataResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ReadTensorboardBlobData(std::string const &, Options)
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 |
time_series |
std::string const &
Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::ReadTensorboardBlobDataResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ReadTensorboardBlobDataResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ReadTensorboardBlobData(google::cloud::aiplatform::v1::ReadTensorboardBlobDataRequest const &, Options)
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 |
google::cloud::aiplatform::v1::ReadTensorboardBlobDataRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::ReadTensorboardBlobDataResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.ReadTensorboardBlobDataResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
WriteTensorboardExperimentData(std::string const &, std::vector< google::cloud::aiplatform::v1::WriteTensorboardRunDataRequest > const &, Options)
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 |
tensorboard_experiment |
std::string const &
Required. The resource name of the TensorboardExperiment to write data to. Format: |
write_run_data_requests |
std::vector< google::cloud::aiplatform::v1::WriteTensorboardRunDataRequest > const &
Required. Requests containing per-run TensorboardTimeSeries data to write. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::WriteTensorboardExperimentDataResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.WriteTensorboardExperimentDataResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
WriteTensorboardExperimentData(google::cloud::aiplatform::v1::WriteTensorboardExperimentDataRequest const &, Options)
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 |
google::cloud::aiplatform::v1::WriteTensorboardExperimentDataRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::WriteTensorboardExperimentDataResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.WriteTensorboardExperimentDataResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
WriteTensorboardRunData(std::string const &, std::vector< google::cloud::aiplatform::v1::TimeSeriesData > const &, Options)
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 |
tensorboard_run |
std::string const &
Required. The resource name of the TensorboardRun to write data to. Format: |
time_series_data |
std::vector< google::cloud::aiplatform::v1::TimeSeriesData > const &
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. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::WriteTensorboardRunDataResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.WriteTensorboardRunDataResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
WriteTensorboardRunData(google::cloud::aiplatform::v1::WriteTensorboardRunDataRequest const &, Options)
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 |
google::cloud::aiplatform::v1::WriteTensorboardRunDataRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::WriteTensorboardRunDataResponse > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.WriteTensorboardRunDataResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ExportTensorboardTimeSeriesData(std::string const &, Options)
Exports a TensorboardTimeSeries' data.
Data is returned in paginated responses.
Parameters | |
---|---|
Name | Description |
tensorboard_time_series |
std::string const &
Required. The resource name of the TensorboardTimeSeries to export data from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::TimeSeriesDataPoint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ExportTensorboardTimeSeriesData(google::cloud::aiplatform::v1::ExportTensorboardTimeSeriesDataRequest, Options)
Exports a TensorboardTimeSeries' data.
Data is returned in paginated responses.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ExportTensorboardTimeSeriesDataRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::TimeSeriesDataPoint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |