Class TensorboardServiceClient (2.23.0-rc)

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: `projects/{project}/locations/{location}`
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.Tensorboard proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateTensorboardRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetTensorboardRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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 `name` field is used to identify the Tensorboard to be updated. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
`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 > >

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UpdateTensorboardRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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: `projects/{project}/locations/{location}`
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.Tensorboard, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListTensorboardsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::Tensorboard >

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteTensorboardRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ReadTensorboardUsageRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ReadTensorboardSizeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
`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. This value should be 1-128 characters, and valid characters are `/[a-z][0-9]-/`.
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateTensorboardExperimentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

GetTensorboardExperiment(std::string const &, Options)

Gets a TensorboardExperiment.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetTensorboardExperimentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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 `name` field is used to identify the TensorboardExperiment to be updated. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UpdateTensorboardExperimentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.TensorboardExperiment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListTensorboardExperimentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.TensorboardExperiment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteTensorboardExperimentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
`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. This value should be 1-128 characters, and valid characters are `/[a-z][0-9]-/`.
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateTensorboardRunRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.BatchCreateTensorboardRunsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

GetTensorboardRun(std::string const &, Options)

Gets a TensorboardRun.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetTensorboardRunRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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 `name` field is used to identify the TensorboardRun to be updated. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UpdateTensorboardRunRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.TensorboardRun, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListTensorboardRunsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.TensorboardRun, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteTensorboardRunRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.BatchCreateTensorboardTimeSeriesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateTensorboardTimeSeriesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

GetTensorboardTimeSeries(std::string const &, Options)

Gets a TensorboardTimeSeries.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetTensorboardTimeSeriesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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' `name` field is used to identify the TensorboardTimeSeries to be updated. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UpdateTensorboardTimeSeriesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.TensorboardTimeSeries, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListTensorboardTimeSeriesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.TensorboardTimeSeries, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteTensorboardTimeSeriesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.
`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 `StatusOr` contains the error details.

BatchReadTensorboardTimeSeriesData(google::cloud::aiplatform::v1::BatchReadTensorboardTimeSeriesDataRequest const &, Options)

Reads multiple TensorboardTimeSeries' data.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::BatchReadTensorboardTimeSeriesDataRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
`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 `StatusOr` contains the error details.

ReadTensorboardTimeSeriesData(google::cloud::aiplatform::v1::ReadTensorboardTimeSeriesDataRequest const &, Options)

Reads a TensorboardTimeSeries' data.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::ReadTensorboardTimeSeriesDataRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ReadTensorboardTimeSeriesDataRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ReadTensorboardBlobDataRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.WriteTensorboardExperimentDataRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.WriteTensorboardRunDataRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 `StatusOr` contains the error details.

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: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.TimeSeriesDataPoint, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ExportTensorboardTimeSeriesDataRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.TimeSeriesDataPoint, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.