Class AMLClient (2.37.0-rc)

The AML (Anti Money Laundering) service allows users to perform REST operations on aml.

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

AMLClient(AMLClient const &)

Copy and move support

Parameter
Name Description
AMLClient const &

AMLClient(AMLClient &&)

Copy and move support

Parameter
Name Description
AMLClient &&

AMLClient(std::shared_ptr< AMLConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< AMLConnection >
opts Options

Operators

operator=(AMLClient const &)

Copy and move support

Parameter
Name Description
AMLClient const &
Returns
Type Description
AMLClient &

operator=(AMLClient &&)

Copy and move support

Parameter
Name Description
AMLClient &&
Returns
Type Description
AMLClient &

Functions

ListInstances(std::string const &, Options)

Lists instances.

Parameters
Name Description
parent std::string const &

Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::financialservices::v1::Instance >

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.financialservices.v1.Instance, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListInstances(google::cloud::financialservices::v1::ListInstancesRequest, Options)

Lists instances.

Parameters
Name Description
request google::cloud::financialservices::v1::ListInstancesRequest

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.financialservices.v1.ListInstancesRequest. 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::financialservices::v1::Instance >

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.financialservices.v1.Instance, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetInstance(std::string const &, Options)

Gets an instance.

Parameters
Name Description
name std::string const &

Required. The resource name of the Instance.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::financialservices::v1::Instance >

the result of the RPC. The response message type (google.cloud.financialservices.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetInstance(google::cloud::financialservices::v1::GetInstanceRequest const &, Options)

Gets an instance.

Parameters
Name Description
request google::cloud::financialservices::v1::GetInstanceRequest 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.financialservices.v1.GetInstanceRequest. 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::financialservices::v1::Instance >

the result of the RPC. The response message type (google.cloud.financialservices.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateInstance(std::string const &, google::cloud::financialservices::v1::Instance const &, std::string const &, Options)

Creates an instance.

Parameters
Name Description
parent std::string const &

Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance.

instance google::cloud::financialservices::v1::Instance const &

Required. The instance that will be created.

instance_id std::string const &

Required. The resource id of the instance.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::Instance > >

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.financialservices.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateInstance(NoAwaitTag, std::string const &, google::cloud::financialservices::v1::Instance const &, std::string const &, Options)

Creates an instance.

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 &
instance google::cloud::financialservices::v1::Instance const &
instance_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateInstance(google::cloud::financialservices::v1::CreateInstanceRequest const &, Options)

Creates an instance.

Parameters
Name Description
request google::cloud::financialservices::v1::CreateInstanceRequest 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.financialservices.v1.CreateInstanceRequest. 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::financialservices::v1::Instance > >

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.financialservices.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateInstance(NoAwaitTag, google::cloud::financialservices::v1::CreateInstanceRequest const &, Options)

Creates an instance.

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::financialservices::v1::CreateInstanceRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateInstance(google::longrunning::Operation const &, Options)

Creates an instance.

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::financialservices::v1::Instance > >

UpdateInstance(google::cloud::financialservices::v1::Instance const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Instance.

Parameters
Name Description
instance google::cloud::financialservices::v1::Instance const &

Required. The new value of the instance fields that will be updated according to the update_mask

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::Instance > >

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.financialservices.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateInstance(NoAwaitTag, google::cloud::financialservices::v1::Instance const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Instance.

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
instance google::cloud::financialservices::v1::Instance const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateInstance(google::cloud::financialservices::v1::UpdateInstanceRequest const &, Options)

Updates the parameters of a single Instance.

Parameters
Name Description
request google::cloud::financialservices::v1::UpdateInstanceRequest 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.financialservices.v1.UpdateInstanceRequest. 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::financialservices::v1::Instance > >

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.financialservices.v1.Instance proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateInstance(NoAwaitTag, google::cloud::financialservices::v1::UpdateInstanceRequest const &, Options)

Updates the parameters of a single Instance.

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::financialservices::v1::UpdateInstanceRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateInstance(google::longrunning::Operation const &, Options)

Updates the parameters of a single Instance.

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::financialservices::v1::Instance > >

DeleteInstance(std::string const &, Options)

Deletes an instance.

Parameters
Name Description
name std::string const &

Required. The resource name of the Instance.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::OperationMetadata > >

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.financialservices.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInstance(NoAwaitTag, std::string const &, Options)

Deletes an instance.

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 >

DeleteInstance(google::cloud::financialservices::v1::DeleteInstanceRequest const &, Options)

Deletes an instance.

Parameters
Name Description
request google::cloud::financialservices::v1::DeleteInstanceRequest 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.financialservices.v1.DeleteInstanceRequest. 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::financialservices::v1::OperationMetadata > >

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.financialservices.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInstance(NoAwaitTag, google::cloud::financialservices::v1::DeleteInstanceRequest const &, Options)

Deletes an instance.

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::financialservices::v1::DeleteInstanceRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteInstance(google::longrunning::Operation const &, Options)

Deletes an instance.

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::financialservices::v1::OperationMetadata > >

ImportRegisteredParties(std::string const &, google::cloud::financialservices::v1::ImportRegisteredPartiesRequest::UpdateMode, google::cloud::financialservices::v1::LineOfBusiness, std::vector< std::string > const &, Options)

Imports the list of registered parties.

See Create and manage instances for information on the input schema and response for this method.

Parameters
Name Description
name std::string const &

Required. The full path to the Instance resource in this API. format: projects/{project}/locations/{location}/instances/{instance}

mode google::cloud::financialservices::v1::ImportRegisteredPartiesRequest::UpdateMode

Required. Mode of the request.

line_of_business google::cloud::financialservices::v1::LineOfBusiness

Required. LineOfBusiness for the specified registered parties.

party_tables std::vector< std::string > const &

Optional. List of BigQuery tables. Union of tables will be taken if there is more than one table. VPC-SC restrictions apply. format: bq://{project}.{bqDatasetID}.{bqTableID} Use of datasets is preferred over the latter due to its simplicity and the reduced risk of errors party_tables and datasets must not be provided at the same time

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::ImportRegisteredPartiesResponse > >

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.financialservices.v1.ImportRegisteredPartiesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ImportRegisteredParties(NoAwaitTag, std::string const &, google::cloud::financialservices::v1::ImportRegisteredPartiesRequest::UpdateMode, google::cloud::financialservices::v1::LineOfBusiness, std::vector< std::string > const &, Options)

Imports the list of registered parties.

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 &
mode google::cloud::financialservices::v1::ImportRegisteredPartiesRequest::UpdateMode
line_of_business google::cloud::financialservices::v1::LineOfBusiness
party_tables std::vector< std::string > const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ImportRegisteredParties(google::cloud::financialservices::v1::ImportRegisteredPartiesRequest const &, Options)

Imports the list of registered parties.

See Create and manage instances for information on the input schema and response for this method.

Parameters
Name Description
request google::cloud::financialservices::v1::ImportRegisteredPartiesRequest 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.financialservices.v1.ImportRegisteredPartiesRequest. 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::financialservices::v1::ImportRegisteredPartiesResponse > >

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.financialservices.v1.ImportRegisteredPartiesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ImportRegisteredParties(NoAwaitTag, google::cloud::financialservices::v1::ImportRegisteredPartiesRequest const &, Options)

Imports the list of registered parties.

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::financialservices::v1::ImportRegisteredPartiesRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ImportRegisteredParties(google::longrunning::Operation const &, Options)

Imports the list of registered parties.

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::financialservices::v1::ImportRegisteredPartiesResponse > >

ExportRegisteredParties(std::string const &, google::cloud::financialservices::v1::BigQueryDestination const &, google::cloud::financialservices::v1::LineOfBusiness, Options)

Exports the list of registered parties.

See Create and manage instances for information on the output schema for this method.

Parameters
Name Description
name std::string const &

Required. The full path to the Instance resource in this API. format: projects/{project}/locations/{location}/instances/{instance}

dataset google::cloud::financialservices::v1::BigQueryDestination const &

Required. The location to output the RegisteredParties.

line_of_business google::cloud::financialservices::v1::LineOfBusiness

Required. LineOfBusiness to get RegisteredParties from.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::ExportRegisteredPartiesResponse > >

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.financialservices.v1.ExportRegisteredPartiesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportRegisteredParties(NoAwaitTag, std::string const &, google::cloud::financialservices::v1::BigQueryDestination const &, google::cloud::financialservices::v1::LineOfBusiness, Options)

Exports the list of registered parties.

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 &
dataset google::cloud::financialservices::v1::BigQueryDestination const &
line_of_business google::cloud::financialservices::v1::LineOfBusiness
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportRegisteredParties(google::cloud::financialservices::v1::ExportRegisteredPartiesRequest const &, Options)

Exports the list of registered parties.

See Create and manage instances for information on the output schema for this method.

Parameters
Name Description
request google::cloud::financialservices::v1::ExportRegisteredPartiesRequest 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.financialservices.v1.ExportRegisteredPartiesRequest. 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::financialservices::v1::ExportRegisteredPartiesResponse > >

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.financialservices.v1.ExportRegisteredPartiesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportRegisteredParties(NoAwaitTag, google::cloud::financialservices::v1::ExportRegisteredPartiesRequest const &, Options)

Exports the list of registered parties.

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::financialservices::v1::ExportRegisteredPartiesRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportRegisteredParties(google::longrunning::Operation const &, Options)

Exports the list of registered parties.

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::financialservices::v1::ExportRegisteredPartiesResponse > >

ListDatasets(std::string const &, Options)

Lists datasets.

Parameters
Name Description
parent std::string const &

Required. The parent of the Dataset is the Instance.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::financialservices::v1::Dataset >

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.financialservices.v1.Dataset, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDatasets(google::cloud::financialservices::v1::ListDatasetsRequest, Options)

Lists datasets.

Parameters
Name Description
request google::cloud::financialservices::v1::ListDatasetsRequest

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.financialservices.v1.ListDatasetsRequest. 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::financialservices::v1::Dataset >

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.financialservices.v1.Dataset, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetDataset(std::string const &, Options)

Gets a dataset.

Parameters
Name Description
name std::string const &

Required. The resource name of the Dataset

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::financialservices::v1::Dataset >

the result of the RPC. The response message type (google.cloud.financialservices.v1.Dataset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetDataset(google::cloud::financialservices::v1::GetDatasetRequest const &, Options)

Gets a dataset.

Parameters
Name Description
request google::cloud::financialservices::v1::GetDatasetRequest 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.financialservices.v1.GetDatasetRequest. 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::financialservices::v1::Dataset >

the result of the RPC. The response message type (google.cloud.financialservices.v1.Dataset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateDataset(std::string const &, google::cloud::financialservices::v1::Dataset const &, std::string const &, Options)

Creates a dataset.

Parameters
Name Description
parent std::string const &

Required. The parent of the Dataset is the Instance.

dataset google::cloud::financialservices::v1::Dataset const &

Required. The dataset that will be created.

dataset_id std::string const &

Required. The resource id of the dataset

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::Dataset > >

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.financialservices.v1.Dataset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDataset(NoAwaitTag, std::string const &, google::cloud::financialservices::v1::Dataset const &, std::string const &, Options)

Creates a dataset.

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 &
dataset google::cloud::financialservices::v1::Dataset const &
dataset_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateDataset(google::cloud::financialservices::v1::CreateDatasetRequest const &, Options)

Creates a dataset.

Parameters
Name Description
request google::cloud::financialservices::v1::CreateDatasetRequest 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.financialservices.v1.CreateDatasetRequest. 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::financialservices::v1::Dataset > >

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.financialservices.v1.Dataset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDataset(NoAwaitTag, google::cloud::financialservices::v1::CreateDatasetRequest const &, Options)

Creates a dataset.

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::financialservices::v1::CreateDatasetRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateDataset(google::longrunning::Operation const &, Options)

Creates a dataset.

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::financialservices::v1::Dataset > >

UpdateDataset(google::cloud::financialservices::v1::Dataset const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Dataset.

Parameters
Name Description
dataset google::cloud::financialservices::v1::Dataset const &

Required. The new value of the dataset fields that will be updated according to the update_mask.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the Dataset resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::Dataset > >

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.financialservices.v1.Dataset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateDataset(NoAwaitTag, google::cloud::financialservices::v1::Dataset const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Dataset.

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
dataset google::cloud::financialservices::v1::Dataset const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateDataset(google::cloud::financialservices::v1::UpdateDatasetRequest const &, Options)

Updates the parameters of a single Dataset.

Parameters
Name Description
request google::cloud::financialservices::v1::UpdateDatasetRequest 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.financialservices.v1.UpdateDatasetRequest. 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::financialservices::v1::Dataset > >

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.financialservices.v1.Dataset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateDataset(NoAwaitTag, google::cloud::financialservices::v1::UpdateDatasetRequest const &, Options)

Updates the parameters of a single Dataset.

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::financialservices::v1::UpdateDatasetRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateDataset(google::longrunning::Operation const &, Options)

Updates the parameters of a single Dataset.

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::financialservices::v1::Dataset > >

DeleteDataset(std::string const &, Options)

Deletes a dataset.

Parameters
Name Description
name std::string const &

Required. The resource name of the Dataset.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::OperationMetadata > >

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.financialservices.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteDataset(NoAwaitTag, std::string const &, Options)

Deletes a dataset.

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 >

DeleteDataset(google::cloud::financialservices::v1::DeleteDatasetRequest const &, Options)

Deletes a dataset.

Parameters
Name Description
request google::cloud::financialservices::v1::DeleteDatasetRequest 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.financialservices.v1.DeleteDatasetRequest. 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::financialservices::v1::OperationMetadata > >

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.financialservices.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteDataset(NoAwaitTag, google::cloud::financialservices::v1::DeleteDatasetRequest const &, Options)

Deletes a dataset.

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::financialservices::v1::DeleteDatasetRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteDataset(google::longrunning::Operation const &, Options)

Deletes a dataset.

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::financialservices::v1::OperationMetadata > >

ListModels(std::string const &, Options)

Lists models.

Parameters
Name Description
parent std::string const &

Required. The parent of the Model is the Instance.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::financialservices::v1::Model >

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.financialservices.v1.Model, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListModels(google::cloud::financialservices::v1::ListModelsRequest, Options)

Lists models.

Parameters
Name Description
request google::cloud::financialservices::v1::ListModelsRequest

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.financialservices.v1.ListModelsRequest. 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::financialservices::v1::Model >

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.financialservices.v1.Model, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetModel(std::string const &, Options)

Gets a model.

Parameters
Name Description
name std::string const &

Required. The resource name of the Model

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::financialservices::v1::Model >

the result of the RPC. The response message type (google.cloud.financialservices.v1.Model) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetModel(google::cloud::financialservices::v1::GetModelRequest const &, Options)

Gets a model.

Parameters
Name Description
request google::cloud::financialservices::v1::GetModelRequest 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.financialservices.v1.GetModelRequest. 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::financialservices::v1::Model >

the result of the RPC. The response message type (google.cloud.financialservices.v1.Model) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateModel(std::string const &, google::cloud::financialservices::v1::Model const &, std::string const &, Options)

Creates a model.

Parameters
Name Description
parent std::string const &

Required. The parent of the Model is the Instance.

model google::cloud::financialservices::v1::Model const &

Required. The Model that will be created.

model_id std::string const &

Required. The resource id of the Model

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::Model > >

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.financialservices.v1.Model proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateModel(NoAwaitTag, std::string const &, google::cloud::financialservices::v1::Model const &, std::string const &, Options)

Creates a model.

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 &
model google::cloud::financialservices::v1::Model const &
model_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateModel(google::cloud::financialservices::v1::CreateModelRequest const &, Options)

Creates a model.

Parameters
Name Description
request google::cloud::financialservices::v1::CreateModelRequest 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.financialservices.v1.CreateModelRequest. 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::financialservices::v1::Model > >

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.financialservices.v1.Model proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateModel(NoAwaitTag, google::cloud::financialservices::v1::CreateModelRequest const &, Options)

Creates a model.

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::financialservices::v1::CreateModelRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateModel(google::longrunning::Operation const &, Options)

Creates a model.

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::financialservices::v1::Model > >

UpdateModel(google::cloud::financialservices::v1::Model const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Model.

Parameters
Name Description
model google::cloud::financialservices::v1::Model const &

Required. The new value of the Model fields that will be updated according to the update_mask.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the Model resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::Model > >

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.financialservices.v1.Model proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateModel(NoAwaitTag, google::cloud::financialservices::v1::Model const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Model.

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
model google::cloud::financialservices::v1::Model const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateModel(google::cloud::financialservices::v1::UpdateModelRequest const &, Options)

Updates the parameters of a single Model.

Parameters
Name Description
request google::cloud::financialservices::v1::UpdateModelRequest 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.financialservices.v1.UpdateModelRequest. 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::financialservices::v1::Model > >

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.financialservices.v1.Model proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateModel(NoAwaitTag, google::cloud::financialservices::v1::UpdateModelRequest const &, Options)

Updates the parameters of a single Model.

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::financialservices::v1::UpdateModelRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateModel(google::longrunning::Operation const &, Options)

Updates the parameters of a single Model.

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::financialservices::v1::Model > >

ExportModelMetadata(std::string const &, google::cloud::financialservices::v1::BigQueryDestination const &, Options)

Export governance information for a Model resource.

For information on the exported fields, see AML output data model.

Parameters
Name Description
model std::string const &

Required. The resource name of the Model.

structured_metadata_destination google::cloud::financialservices::v1::BigQueryDestination const &

Required. BigQuery output where the metadata will be written.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::ExportModelMetadataResponse > >

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.financialservices.v1.ExportModelMetadataResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportModelMetadata(NoAwaitTag, std::string const &, google::cloud::financialservices::v1::BigQueryDestination const &, Options)

Export governance information for a Model resource.

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
model std::string const &
structured_metadata_destination google::cloud::financialservices::v1::BigQueryDestination const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportModelMetadata(google::cloud::financialservices::v1::ExportModelMetadataRequest const &, Options)

Export governance information for a Model resource.

For information on the exported fields, see AML output data model.

Parameters
Name Description
request google::cloud::financialservices::v1::ExportModelMetadataRequest 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.financialservices.v1.ExportModelMetadataRequest. 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::financialservices::v1::ExportModelMetadataResponse > >

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.financialservices.v1.ExportModelMetadataResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportModelMetadata(NoAwaitTag, google::cloud::financialservices::v1::ExportModelMetadataRequest const &, Options)

Export governance information for a Model resource.

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::financialservices::v1::ExportModelMetadataRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportModelMetadata(google::longrunning::Operation const &, Options)

Export governance information for a Model resource.

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::financialservices::v1::ExportModelMetadataResponse > >

DeleteModel(std::string const &, Options)

Deletes a model.

Parameters
Name Description
name std::string const &

Required. The resource name of the Model.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::OperationMetadata > >

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.financialservices.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteModel(NoAwaitTag, std::string const &, Options)

Deletes a model.

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 >

DeleteModel(google::cloud::financialservices::v1::DeleteModelRequest const &, Options)

Deletes a model.

Parameters
Name Description
request google::cloud::financialservices::v1::DeleteModelRequest 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.financialservices.v1.DeleteModelRequest. 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::financialservices::v1::OperationMetadata > >

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.financialservices.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteModel(NoAwaitTag, google::cloud::financialservices::v1::DeleteModelRequest const &, Options)

Deletes a model.

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::financialservices::v1::DeleteModelRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteModel(google::longrunning::Operation const &, Options)

Deletes a model.

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::financialservices::v1::OperationMetadata > >

ListEngineConfigs(std::string const &, Options)

Lists engine configs.

Parameters
Name Description
parent std::string const &

Required. The parent of the EngineConfig is the Instance.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::financialservices::v1::EngineConfig >

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.financialservices.v1.EngineConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEngineConfigs(google::cloud::financialservices::v1::ListEngineConfigsRequest, Options)

Lists engine configs.

Parameters
Name Description
request google::cloud::financialservices::v1::ListEngineConfigsRequest

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.financialservices.v1.ListEngineConfigsRequest. 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::financialservices::v1::EngineConfig >

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.financialservices.v1.EngineConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetEngineConfig(std::string const &, Options)

Gets an engine config.

Parameters
Name Description
name std::string const &

Required. The resource name of the EngineConfig

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::financialservices::v1::EngineConfig >

the result of the RPC. The response message type (google.cloud.financialservices.v1.EngineConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetEngineConfig(google::cloud::financialservices::v1::GetEngineConfigRequest const &, Options)

Gets an engine config.

Parameters
Name Description
request google::cloud::financialservices::v1::GetEngineConfigRequest 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.financialservices.v1.GetEngineConfigRequest. 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::financialservices::v1::EngineConfig >

the result of the RPC. The response message type (google.cloud.financialservices.v1.EngineConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateEngineConfig(std::string const &, google::cloud::financialservices::v1::EngineConfig const &, std::string const &, Options)

Creates an engine config.

Parameters
Name Description
parent std::string const &

Required. The parent of the EngineConfig is the Instance.

engine_config google::cloud::financialservices::v1::EngineConfig const &

Required. The EngineConfig that will be created.

engine_config_id std::string const &

Required. The resource id of the EngineConfig

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::EngineConfig > >

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.financialservices.v1.EngineConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateEngineConfig(NoAwaitTag, std::string const &, google::cloud::financialservices::v1::EngineConfig const &, std::string const &, Options)

Creates an engine config.

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 &
engine_config google::cloud::financialservices::v1::EngineConfig const &
engine_config_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateEngineConfig(google::cloud::financialservices::v1::CreateEngineConfigRequest const &, Options)

Creates an engine config.

Parameters
Name Description
request google::cloud::financialservices::v1::CreateEngineConfigRequest 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.financialservices.v1.CreateEngineConfigRequest. 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::financialservices::v1::EngineConfig > >

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.financialservices.v1.EngineConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateEngineConfig(NoAwaitTag, google::cloud::financialservices::v1::CreateEngineConfigRequest const &, Options)

Creates an engine config.

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::financialservices::v1::CreateEngineConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateEngineConfig(google::longrunning::Operation const &, Options)

Creates an engine config.

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::financialservices::v1::EngineConfig > >

UpdateEngineConfig(google::cloud::financialservices::v1::EngineConfig const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single EngineConfig.

Parameters
Name Description
engine_config google::cloud::financialservices::v1::EngineConfig const &

Required. The new value of the EngineConfig fields that will be updated according to the update_mask.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the EngineConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::EngineConfig > >

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.financialservices.v1.EngineConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateEngineConfig(NoAwaitTag, google::cloud::financialservices::v1::EngineConfig const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single EngineConfig.

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
engine_config google::cloud::financialservices::v1::EngineConfig const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateEngineConfig(google::cloud::financialservices::v1::UpdateEngineConfigRequest const &, Options)

Updates the parameters of a single EngineConfig.

Parameters
Name Description
request google::cloud::financialservices::v1::UpdateEngineConfigRequest 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.financialservices.v1.UpdateEngineConfigRequest. 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::financialservices::v1::EngineConfig > >

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.financialservices.v1.EngineConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateEngineConfig(NoAwaitTag, google::cloud::financialservices::v1::UpdateEngineConfigRequest const &, Options)

Updates the parameters of a single EngineConfig.

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::financialservices::v1::UpdateEngineConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateEngineConfig(google::longrunning::Operation const &, Options)

Updates the parameters of a single EngineConfig.

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::financialservices::v1::EngineConfig > >

ExportEngineConfigMetadata(std::string const &, google::cloud::financialservices::v1::BigQueryDestination const &, Options)

Export governance information for an EngineConfig resource.

For information on the exported fields, see AML output data model.

Parameters
Name Description
engine_config std::string const &

Required. The resource name of the EngineConfig.

structured_metadata_destination google::cloud::financialservices::v1::BigQueryDestination const &

Required. BigQuery output where the metadata will be written.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::ExportEngineConfigMetadataResponse > >

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.financialservices.v1.ExportEngineConfigMetadataResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportEngineConfigMetadata(NoAwaitTag, std::string const &, google::cloud::financialservices::v1::BigQueryDestination const &, Options)

Export governance information for an EngineConfig resource.

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
engine_config std::string const &
structured_metadata_destination google::cloud::financialservices::v1::BigQueryDestination const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportEngineConfigMetadata(google::cloud::financialservices::v1::ExportEngineConfigMetadataRequest const &, Options)

Export governance information for an EngineConfig resource.

For information on the exported fields, see AML output data model.

Parameters
Name Description
request google::cloud::financialservices::v1::ExportEngineConfigMetadataRequest 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.financialservices.v1.ExportEngineConfigMetadataRequest. 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::financialservices::v1::ExportEngineConfigMetadataResponse > >

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.financialservices.v1.ExportEngineConfigMetadataResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportEngineConfigMetadata(NoAwaitTag, google::cloud::financialservices::v1::ExportEngineConfigMetadataRequest const &, Options)

Export governance information for an EngineConfig resource.

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::financialservices::v1::ExportEngineConfigMetadataRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportEngineConfigMetadata(google::longrunning::Operation const &, Options)

Export governance information for an EngineConfig resource.

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::financialservices::v1::ExportEngineConfigMetadataResponse > >

DeleteEngineConfig(std::string const &, Options)

Deletes an engine config.

Parameters
Name Description
name std::string const &

Required. The resource name of the EngineConfig.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::OperationMetadata > >

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.financialservices.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteEngineConfig(NoAwaitTag, std::string const &, Options)

Deletes an engine config.

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 >

DeleteEngineConfig(google::cloud::financialservices::v1::DeleteEngineConfigRequest const &, Options)

Deletes an engine config.

Parameters
Name Description
request google::cloud::financialservices::v1::DeleteEngineConfigRequest 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.financialservices.v1.DeleteEngineConfigRequest. 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::financialservices::v1::OperationMetadata > >

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.financialservices.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteEngineConfig(NoAwaitTag, google::cloud::financialservices::v1::DeleteEngineConfigRequest const &, Options)

Deletes an engine config.

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::financialservices::v1::DeleteEngineConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteEngineConfig(google::longrunning::Operation const &, Options)

Deletes an engine config.

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::financialservices::v1::OperationMetadata > >

GetEngineVersion(std::string const &, Options)

Gets a single EngineVersion.

Parameters
Name Description
name std::string const &

Required. The resource name of the EngineVersion

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::financialservices::v1::EngineVersion >

the result of the RPC. The response message type (google.cloud.financialservices.v1.EngineVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetEngineVersion(google::cloud::financialservices::v1::GetEngineVersionRequest const &, Options)

Gets a single EngineVersion.

Parameters
Name Description
request google::cloud::financialservices::v1::GetEngineVersionRequest 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.financialservices.v1.GetEngineVersionRequest. 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::financialservices::v1::EngineVersion >

the result of the RPC. The response message type (google.cloud.financialservices.v1.EngineVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListEngineVersions(std::string const &, Options)

Lists EngineVersions for given location.

Parameters
Name Description
parent std::string const &

Required. The parent of the EngineVersion is the Instance.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::financialservices::v1::EngineVersion >

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.financialservices.v1.EngineVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEngineVersions(google::cloud::financialservices::v1::ListEngineVersionsRequest, Options)

Lists EngineVersions for given location.

Parameters
Name Description
request google::cloud::financialservices::v1::ListEngineVersionsRequest

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.financialservices.v1.ListEngineVersionsRequest. 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::financialservices::v1::EngineVersion >

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.financialservices.v1.EngineVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPredictionResults(std::string const &, Options)

List PredictionResults.

Parameters
Name Description
parent std::string const &

Required. The parent of the PredictionResult is the Instance.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::financialservices::v1::PredictionResult >

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.financialservices.v1.PredictionResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPredictionResults(google::cloud::financialservices::v1::ListPredictionResultsRequest, Options)

List PredictionResults.

Parameters
Name Description
request google::cloud::financialservices::v1::ListPredictionResultsRequest

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.financialservices.v1.ListPredictionResultsRequest. 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::financialservices::v1::PredictionResult >

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.financialservices.v1.PredictionResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetPredictionResult(std::string const &, Options)

Gets a PredictionResult.

Parameters
Name Description
name std::string const &

Required. The resource name of the PredictionResult

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::financialservices::v1::PredictionResult >

the result of the RPC. The response message type (google.cloud.financialservices.v1.PredictionResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetPredictionResult(google::cloud::financialservices::v1::GetPredictionResultRequest const &, Options)

Gets a PredictionResult.

Parameters
Name Description
request google::cloud::financialservices::v1::GetPredictionResultRequest 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.financialservices.v1.GetPredictionResultRequest. 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::financialservices::v1::PredictionResult >

the result of the RPC. The response message type (google.cloud.financialservices.v1.PredictionResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreatePredictionResult(std::string const &, google::cloud::financialservices::v1::PredictionResult const &, std::string const &, Options)

Create a PredictionResult.

Parameters
Name Description
parent std::string const &

Required. The parent of the PredictionResult is the Instance.

prediction_result google::cloud::financialservices::v1::PredictionResult const &

Required. The PredictionResult that will be created.

prediction_result_id std::string const &

Required. The resource id of the PredictionResult

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::PredictionResult > >

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.financialservices.v1.PredictionResult proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreatePredictionResult(NoAwaitTag, std::string const &, google::cloud::financialservices::v1::PredictionResult const &, std::string const &, Options)

Create a PredictionResult.

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 &
prediction_result google::cloud::financialservices::v1::PredictionResult const &
prediction_result_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreatePredictionResult(google::cloud::financialservices::v1::CreatePredictionResultRequest const &, Options)

Create a PredictionResult.

Parameters
Name Description
request google::cloud::financialservices::v1::CreatePredictionResultRequest 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.financialservices.v1.CreatePredictionResultRequest. 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::financialservices::v1::PredictionResult > >

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.financialservices.v1.PredictionResult proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreatePredictionResult(NoAwaitTag, google::cloud::financialservices::v1::CreatePredictionResultRequest const &, Options)

Create a PredictionResult.

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::financialservices::v1::CreatePredictionResultRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreatePredictionResult(google::longrunning::Operation const &, Options)

Create a PredictionResult.

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::financialservices::v1::PredictionResult > >

UpdatePredictionResult(google::cloud::financialservices::v1::PredictionResult const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single PredictionResult.

Parameters
Name Description
prediction_result google::cloud::financialservices::v1::PredictionResult const &

Required. The new value of the PredictionResult fields that will be updated according to the update_mask.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the PredictionResult resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::PredictionResult > >

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.financialservices.v1.PredictionResult proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdatePredictionResult(NoAwaitTag, google::cloud::financialservices::v1::PredictionResult const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single PredictionResult.

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
prediction_result google::cloud::financialservices::v1::PredictionResult const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdatePredictionResult(google::cloud::financialservices::v1::UpdatePredictionResultRequest const &, Options)

Updates the parameters of a single PredictionResult.

Parameters
Name Description
request google::cloud::financialservices::v1::UpdatePredictionResultRequest 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.financialservices.v1.UpdatePredictionResultRequest. 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::financialservices::v1::PredictionResult > >

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.financialservices.v1.PredictionResult proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdatePredictionResult(NoAwaitTag, google::cloud::financialservices::v1::UpdatePredictionResultRequest const &, Options)

Updates the parameters of a single PredictionResult.

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::financialservices::v1::UpdatePredictionResultRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdatePredictionResult(google::longrunning::Operation const &, Options)

Updates the parameters of a single PredictionResult.

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::financialservices::v1::PredictionResult > >

ExportPredictionResultMetadata(std::string const &, google::cloud::financialservices::v1::BigQueryDestination const &, Options)

Export governance information for a PredictionResult resource.

For information on the exported fields, see AML output data model.

Parameters
Name Description
prediction_result std::string const &

Required. The resource name of the PredictionResult.

structured_metadata_destination google::cloud::financialservices::v1::BigQueryDestination const &

Required. BigQuery output where the metadata will be written.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::ExportPredictionResultMetadataResponse > >

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.financialservices.v1.ExportPredictionResultMetadataResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportPredictionResultMetadata(NoAwaitTag, std::string const &, google::cloud::financialservices::v1::BigQueryDestination const &, Options)

Export governance information for a PredictionResult resource.

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
prediction_result std::string const &
structured_metadata_destination google::cloud::financialservices::v1::BigQueryDestination const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportPredictionResultMetadata(google::cloud::financialservices::v1::ExportPredictionResultMetadataRequest const &, Options)

Export governance information for a PredictionResult resource.

For information on the exported fields, see AML output data model.

Parameters
Name Description
request google::cloud::financialservices::v1::ExportPredictionResultMetadataRequest 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.financialservices.v1.ExportPredictionResultMetadataRequest. 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::financialservices::v1::ExportPredictionResultMetadataResponse > >

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.financialservices.v1.ExportPredictionResultMetadataResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportPredictionResultMetadata(NoAwaitTag, google::cloud::financialservices::v1::ExportPredictionResultMetadataRequest const &, Options)

Export governance information for a PredictionResult resource.

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::financialservices::v1::ExportPredictionResultMetadataRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportPredictionResultMetadata(google::longrunning::Operation const &, Options)

Export governance information for a PredictionResult resource.

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::financialservices::v1::ExportPredictionResultMetadataResponse > >

DeletePredictionResult(std::string const &, Options)

Deletes a PredictionResult.

Parameters
Name Description
name std::string const &

Required. The resource name of the PredictionResult.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::OperationMetadata > >

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.financialservices.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeletePredictionResult(NoAwaitTag, std::string const &, Options)

Deletes a PredictionResult.

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 >

DeletePredictionResult(google::cloud::financialservices::v1::DeletePredictionResultRequest const &, Options)

Deletes a PredictionResult.

Parameters
Name Description
request google::cloud::financialservices::v1::DeletePredictionResultRequest 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.financialservices.v1.DeletePredictionResultRequest. 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::financialservices::v1::OperationMetadata > >

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.financialservices.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeletePredictionResult(NoAwaitTag, google::cloud::financialservices::v1::DeletePredictionResultRequest const &, Options)

Deletes a PredictionResult.

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::financialservices::v1::DeletePredictionResultRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeletePredictionResult(google::longrunning::Operation const &, Options)

Deletes a PredictionResult.

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::financialservices::v1::OperationMetadata > >

ListBacktestResults(std::string const &, Options)

List BacktestResults.

Parameters
Name Description
parent std::string const &

Required. The parent of the BacktestResult is the Instance.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::financialservices::v1::BacktestResult >

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.financialservices.v1.BacktestResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListBacktestResults(google::cloud::financialservices::v1::ListBacktestResultsRequest, Options)

List BacktestResults.

Parameters
Name Description
request google::cloud::financialservices::v1::ListBacktestResultsRequest

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.financialservices.v1.ListBacktestResultsRequest. 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::financialservices::v1::BacktestResult >

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.financialservices.v1.BacktestResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetBacktestResult(std::string const &, Options)

Gets a BacktestResult.

Parameters
Name Description
name std::string const &

Required. The resource name of the BacktestResult

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::financialservices::v1::BacktestResult >

the result of the RPC. The response message type (google.cloud.financialservices.v1.BacktestResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetBacktestResult(google::cloud::financialservices::v1::GetBacktestResultRequest const &, Options)

Gets a BacktestResult.

Parameters
Name Description
request google::cloud::financialservices::v1::GetBacktestResultRequest 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.financialservices.v1.GetBacktestResultRequest. 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::financialservices::v1::BacktestResult >

the result of the RPC. The response message type (google.cloud.financialservices.v1.BacktestResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateBacktestResult(std::string const &, google::cloud::financialservices::v1::BacktestResult const &, std::string const &, Options)

Create a BacktestResult.

Parameters
Name Description
parent std::string const &

Required. The parent of the BacktestResult is the Instance.

backtest_result google::cloud::financialservices::v1::BacktestResult const &

Required. The BacktestResult that will be created.

backtest_result_id std::string const &

Required. The resource id of the BacktestResult

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::BacktestResult > >

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.financialservices.v1.BacktestResult proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateBacktestResult(NoAwaitTag, std::string const &, google::cloud::financialservices::v1::BacktestResult const &, std::string const &, Options)

Create a BacktestResult.

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 &
backtest_result google::cloud::financialservices::v1::BacktestResult const &
backtest_result_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateBacktestResult(google::cloud::financialservices::v1::CreateBacktestResultRequest const &, Options)

Create a BacktestResult.

Parameters
Name Description
request google::cloud::financialservices::v1::CreateBacktestResultRequest 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.financialservices.v1.CreateBacktestResultRequest. 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::financialservices::v1::BacktestResult > >

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.financialservices.v1.BacktestResult proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateBacktestResult(NoAwaitTag, google::cloud::financialservices::v1::CreateBacktestResultRequest const &, Options)

Create a BacktestResult.

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::financialservices::v1::CreateBacktestResultRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateBacktestResult(google::longrunning::Operation const &, Options)

Create a BacktestResult.

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::financialservices::v1::BacktestResult > >

UpdateBacktestResult(google::cloud::financialservices::v1::BacktestResult const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single BacktestResult.

Parameters
Name Description
backtest_result google::cloud::financialservices::v1::BacktestResult const &

Required. The new value of the BacktestResult fields that will be updated according to the update_mask.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the BacktestResult resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::BacktestResult > >

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.financialservices.v1.BacktestResult proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBacktestResult(NoAwaitTag, google::cloud::financialservices::v1::BacktestResult const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single BacktestResult.

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
backtest_result google::cloud::financialservices::v1::BacktestResult const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateBacktestResult(google::cloud::financialservices::v1::UpdateBacktestResultRequest const &, Options)

Updates the parameters of a single BacktestResult.

Parameters
Name Description
request google::cloud::financialservices::v1::UpdateBacktestResultRequest 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.financialservices.v1.UpdateBacktestResultRequest. 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::financialservices::v1::BacktestResult > >

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.financialservices.v1.BacktestResult proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateBacktestResult(NoAwaitTag, google::cloud::financialservices::v1::UpdateBacktestResultRequest const &, Options)

Updates the parameters of a single BacktestResult.

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::financialservices::v1::UpdateBacktestResultRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateBacktestResult(google::longrunning::Operation const &, Options)

Updates the parameters of a single BacktestResult.

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::financialservices::v1::BacktestResult > >

ExportBacktestResultMetadata(std::string const &, google::cloud::financialservices::v1::BigQueryDestination const &, Options)

Export governance information for a BacktestResult resource.

For information on the exported fields, see AML output data model.

Parameters
Name Description
backtest_result std::string const &

Required. The resource name of the BacktestResult.

structured_metadata_destination google::cloud::financialservices::v1::BigQueryDestination const &

Required. BigQuery output where the metadata will be written.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::ExportBacktestResultMetadataResponse > >

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.financialservices.v1.ExportBacktestResultMetadataResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportBacktestResultMetadata(NoAwaitTag, std::string const &, google::cloud::financialservices::v1::BigQueryDestination const &, Options)

Export governance information for a BacktestResult resource.

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
backtest_result std::string const &
structured_metadata_destination google::cloud::financialservices::v1::BigQueryDestination const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportBacktestResultMetadata(google::cloud::financialservices::v1::ExportBacktestResultMetadataRequest const &, Options)

Export governance information for a BacktestResult resource.

For information on the exported fields, see AML output data model.

Parameters
Name Description
request google::cloud::financialservices::v1::ExportBacktestResultMetadataRequest 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.financialservices.v1.ExportBacktestResultMetadataRequest. 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::financialservices::v1::ExportBacktestResultMetadataResponse > >

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.financialservices.v1.ExportBacktestResultMetadataResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportBacktestResultMetadata(NoAwaitTag, google::cloud::financialservices::v1::ExportBacktestResultMetadataRequest const &, Options)

Export governance information for a BacktestResult resource.

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::financialservices::v1::ExportBacktestResultMetadataRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ExportBacktestResultMetadata(google::longrunning::Operation const &, Options)

Export governance information for a BacktestResult resource.

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::financialservices::v1::ExportBacktestResultMetadataResponse > >

DeleteBacktestResult(std::string const &, Options)

Deletes a BacktestResult.

Parameters
Name Description
name std::string const &

Required. The resource name of the BacktestResult.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::financialservices::v1::OperationMetadata > >

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.financialservices.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteBacktestResult(NoAwaitTag, std::string const &, Options)

Deletes a BacktestResult.

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 >

DeleteBacktestResult(google::cloud::financialservices::v1::DeleteBacktestResultRequest const &, Options)

Deletes a BacktestResult.

Parameters
Name Description
request google::cloud::financialservices::v1::DeleteBacktestResultRequest 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.financialservices.v1.DeleteBacktestResultRequest. 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::financialservices::v1::OperationMetadata > >

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.financialservices.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteBacktestResult(NoAwaitTag, google::cloud::financialservices::v1::DeleteBacktestResultRequest const &, Options)

Deletes a BacktestResult.

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::financialservices::v1::DeleteBacktestResultRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteBacktestResult(google::longrunning::Operation const &, Options)

Deletes a BacktestResult.

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::financialservices::v1::OperationMetadata > >

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name Description
request google::cloud::location::ListLocationsRequest

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.location.ListLocationsRequest. 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::location::Location >

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.location.Location, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

Parameters
Name Description
request google::cloud::location::GetLocationRequest 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.location.GetLocationRequest. 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::location::Location >

the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListOperations(std::string const &, std::string const &, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation's parent resource.

filter std::string const &

The standard list filter.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::longrunning::Operation >

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.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListOperations(google::longrunning::ListOperationsRequest, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::ListOperationsRequest

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.longrunning.ListOperationsRequest. 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::longrunning::Operation >

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.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
name std::string const &

The name of the operation resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::longrunning::Operation >

the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
request google::longrunning::GetOperationRequest 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.longrunning.GetOperationRequest. 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::longrunning::Operation >

the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be deleted.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::DeleteOperationRequest 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.longrunning.DeleteOperationRequest. 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
Status

a Status object. If the request failed, the status contains the details of the failure.

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be cancelled.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

CancelOperation(google::longrunning::CancelOperationRequest const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request google::longrunning::CancelOperationRequest 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.longrunning.CancelOperationRequest. 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
Status

a Status object. If the request failed, the status contains the details of the failure.