Financial Services v1 API - Class AML.AMLBase (1.0.0-beta02)

Version latest

• 1.0.0-beta02 (latest)
• 1.0.0-beta01

[BindServiceMethod(typeof(AML), "BindService")]
public abstract class AML.AMLBase

Reference documentation and code samples for the Financial Services v1 API class AML.AMLBase.

Base class for server-side implementations of AML

Inheritance

object > AML.AMLBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.FinancialServices.V1

Assembly

Google.Cloud.FinancialServices.V1.dll

Methods

CreateBacktestResult(CreateBacktestResultRequest, ServerCallContext)

public virtual Task<Operation> CreateBacktestResult(CreateBacktestResultRequest request, ServerCallContext context)

Create a BacktestResult.

Parameters
Name	Description
request	CreateBacktestResultRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateDataset(CreateDatasetRequest, ServerCallContext)

public virtual Task<Operation> CreateDataset(CreateDatasetRequest request, ServerCallContext context)

Creates a dataset.

Parameters
Name	Description
request	CreateDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateEngineConfig(CreateEngineConfigRequest, ServerCallContext)

public virtual Task<Operation> CreateEngineConfig(CreateEngineConfigRequest request, ServerCallContext context)

Creates an engine config.

Parameters
Name	Description
request	CreateEngineConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateInstance(CreateInstanceRequest, ServerCallContext)

public virtual Task<Operation> CreateInstance(CreateInstanceRequest request, ServerCallContext context)

Creates an instance.

Parameters
Name	Description
request	CreateInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateModel(CreateModelRequest, ServerCallContext)

public virtual Task<Operation> CreateModel(CreateModelRequest request, ServerCallContext context)

Creates a model.

Parameters
Name	Description
request	CreateModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreatePredictionResult(CreatePredictionResultRequest, ServerCallContext)

public virtual Task<Operation> CreatePredictionResult(CreatePredictionResultRequest request, ServerCallContext context)

Create a PredictionResult.

Parameters
Name	Description
request	CreatePredictionResultRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteBacktestResult(DeleteBacktestResultRequest, ServerCallContext)

public virtual Task<Operation> DeleteBacktestResult(DeleteBacktestResultRequest request, ServerCallContext context)

Deletes a BacktestResult.

Parameters
Name	Description
request	DeleteBacktestResultRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteDataset(DeleteDatasetRequest, ServerCallContext)

public virtual Task<Operation> DeleteDataset(DeleteDatasetRequest request, ServerCallContext context)

Deletes a dataset.

Parameters
Name	Description
request	DeleteDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteEngineConfig(DeleteEngineConfigRequest, ServerCallContext)

public virtual Task<Operation> DeleteEngineConfig(DeleteEngineConfigRequest request, ServerCallContext context)

Deletes an engine config.

Parameters
Name	Description
request	DeleteEngineConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteInstance(DeleteInstanceRequest, ServerCallContext)

public virtual Task<Operation> DeleteInstance(DeleteInstanceRequest request, ServerCallContext context)

Deletes an instance.

Parameters
Name	Description
request	DeleteInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteModel(DeleteModelRequest, ServerCallContext)

public virtual Task<Operation> DeleteModel(DeleteModelRequest request, ServerCallContext context)

Deletes a model.

Parameters
Name	Description
request	DeleteModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeletePredictionResult(DeletePredictionResultRequest, ServerCallContext)

public virtual Task<Operation> DeletePredictionResult(DeletePredictionResultRequest request, ServerCallContext context)

Deletes a PredictionResult.

Parameters
Name	Description
request	DeletePredictionResultRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ExportBacktestResultMetadata(ExportBacktestResultMetadataRequest, ServerCallContext)

public virtual Task<Operation> ExportBacktestResultMetadata(ExportBacktestResultMetadataRequest request, ServerCallContext context)

Export governance information for a BacktestResult resource. For information on the exported fields, see AML output data model.

Parameters
Name	Description
request	ExportBacktestResultMetadataRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ExportEngineConfigMetadata(ExportEngineConfigMetadataRequest, ServerCallContext)

public virtual Task<Operation> ExportEngineConfigMetadata(ExportEngineConfigMetadataRequest request, ServerCallContext context)

Export governance information for an EngineConfig resource. For information on the exported fields, see AML output data model.

Parameters
Name	Description
request	ExportEngineConfigMetadataRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ExportModelMetadata(ExportModelMetadataRequest, ServerCallContext)

public virtual Task<Operation> ExportModelMetadata(ExportModelMetadataRequest request, ServerCallContext context)

Export governance information for a Model resource. For information on the exported fields, see AML output data model.

Parameters
Name	Description
request	ExportModelMetadataRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ExportPredictionResultMetadata(ExportPredictionResultMetadataRequest, ServerCallContext)

public virtual Task<Operation> ExportPredictionResultMetadata(ExportPredictionResultMetadataRequest request, ServerCallContext context)

Export governance information for a PredictionResult resource. For information on the exported fields, see AML output data model.

Parameters
Name	Description
request	ExportPredictionResultMetadataRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ExportRegisteredParties(ExportRegisteredPartiesRequest, ServerCallContext)

public virtual Task<Operation> ExportRegisteredParties(ExportRegisteredPartiesRequest request, ServerCallContext context)

Exports the list of registered parties. See Create and manage instances for information on the output schema for this method.

Parameters
Name	Description
request	ExportRegisteredPartiesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetBacktestResult(GetBacktestResultRequest, ServerCallContext)

public virtual Task<BacktestResult> GetBacktestResult(GetBacktestResultRequest request, ServerCallContext context)

Gets a BacktestResult.

Parameters
Name	Description
request	GetBacktestResultRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBacktestResult	The response to send back to the client (wrapped by a task).

GetDataset(GetDatasetRequest, ServerCallContext)

public virtual Task<Dataset> GetDataset(GetDatasetRequest request, ServerCallContext context)

Gets a dataset.

Parameters
Name	Description
request	GetDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDataset	The response to send back to the client (wrapped by a task).

GetEngineConfig(GetEngineConfigRequest, ServerCallContext)

public virtual Task<EngineConfig> GetEngineConfig(GetEngineConfigRequest request, ServerCallContext context)

Gets an engine config.

Parameters
Name	Description
request	GetEngineConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEngineConfig	The response to send back to the client (wrapped by a task).

GetEngineVersion(GetEngineVersionRequest, ServerCallContext)

public virtual Task<EngineVersion> GetEngineVersion(GetEngineVersionRequest request, ServerCallContext context)

Gets a single EngineVersion.

Parameters
Name	Description
request	GetEngineVersionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEngineVersion	The response to send back to the client (wrapped by a task).

GetInstance(GetInstanceRequest, ServerCallContext)

public virtual Task<Instance> GetInstance(GetInstanceRequest request, ServerCallContext context)

Gets an instance.

Parameters
Name	Description
request	GetInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskInstance	The response to send back to the client (wrapped by a task).

GetModel(GetModelRequest, ServerCallContext)

public virtual Task<Model> GetModel(GetModelRequest request, ServerCallContext context)

Gets a model.

Parameters
Name	Description
request	GetModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskModel	The response to send back to the client (wrapped by a task).

GetPredictionResult(GetPredictionResultRequest, ServerCallContext)

public virtual Task<PredictionResult> GetPredictionResult(GetPredictionResultRequest request, ServerCallContext context)

Gets a PredictionResult.

Parameters
Name	Description
request	GetPredictionResultRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPredictionResult	The response to send back to the client (wrapped by a task).

ImportRegisteredParties(ImportRegisteredPartiesRequest, ServerCallContext)

public virtual Task<Operation> ImportRegisteredParties(ImportRegisteredPartiesRequest request, ServerCallContext context)

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	ImportRegisteredPartiesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ListBacktestResults(ListBacktestResultsRequest, ServerCallContext)

public virtual Task<ListBacktestResultsResponse> ListBacktestResults(ListBacktestResultsRequest request, ServerCallContext context)

List BacktestResults.

Parameters
Name	Description
request	ListBacktestResultsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListBacktestResultsResponse	The response to send back to the client (wrapped by a task).

ListDatasets(ListDatasetsRequest, ServerCallContext)

public virtual Task<ListDatasetsResponse> ListDatasets(ListDatasetsRequest request, ServerCallContext context)

Lists datasets.

Parameters
Name	Description
request	ListDatasetsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListDatasetsResponse	The response to send back to the client (wrapped by a task).

ListEngineConfigs(ListEngineConfigsRequest, ServerCallContext)

public virtual Task<ListEngineConfigsResponse> ListEngineConfigs(ListEngineConfigsRequest request, ServerCallContext context)

Lists engine configs.

Parameters
Name	Description
request	ListEngineConfigsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListEngineConfigsResponse	The response to send back to the client (wrapped by a task).

ListEngineVersions(ListEngineVersionsRequest, ServerCallContext)

public virtual Task<ListEngineVersionsResponse> ListEngineVersions(ListEngineVersionsRequest request, ServerCallContext context)

Lists EngineVersions for given location.

Parameters
Name	Description
request	ListEngineVersionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListEngineVersionsResponse	The response to send back to the client (wrapped by a task).

ListInstances(ListInstancesRequest, ServerCallContext)

public virtual Task<ListInstancesResponse> ListInstances(ListInstancesRequest request, ServerCallContext context)

Lists instances.

Parameters
Name	Description
request	ListInstancesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListInstancesResponse	The response to send back to the client (wrapped by a task).

ListModels(ListModelsRequest, ServerCallContext)

public virtual Task<ListModelsResponse> ListModels(ListModelsRequest request, ServerCallContext context)

Lists models.

Parameters
Name	Description
request	ListModelsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListModelsResponse	The response to send back to the client (wrapped by a task).

ListPredictionResults(ListPredictionResultsRequest, ServerCallContext)

public virtual Task<ListPredictionResultsResponse> ListPredictionResults(ListPredictionResultsRequest request, ServerCallContext context)

List PredictionResults.

Parameters
Name	Description
request	ListPredictionResultsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListPredictionResultsResponse	The response to send back to the client (wrapped by a task).

UpdateBacktestResult(UpdateBacktestResultRequest, ServerCallContext)

public virtual Task<Operation> UpdateBacktestResult(UpdateBacktestResultRequest request, ServerCallContext context)

Updates the parameters of a single BacktestResult.

Parameters
Name	Description
request	UpdateBacktestResultRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateDataset(UpdateDatasetRequest, ServerCallContext)

public virtual Task<Operation> UpdateDataset(UpdateDatasetRequest request, ServerCallContext context)

Updates the parameters of a single Dataset.

Parameters
Name	Description
request	UpdateDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateEngineConfig(UpdateEngineConfigRequest, ServerCallContext)

public virtual Task<Operation> UpdateEngineConfig(UpdateEngineConfigRequest request, ServerCallContext context)

Updates the parameters of a single EngineConfig.

Parameters
Name	Description
request	UpdateEngineConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateInstance(UpdateInstanceRequest, ServerCallContext)

public virtual Task<Operation> UpdateInstance(UpdateInstanceRequest request, ServerCallContext context)

Updates the parameters of a single Instance.

Parameters
Name	Description
request	UpdateInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateModel(UpdateModelRequest, ServerCallContext)

public virtual Task<Operation> UpdateModel(UpdateModelRequest request, ServerCallContext context)

Updates the parameters of a single Model.

Parameters
Name	Description
request	UpdateModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdatePredictionResult(UpdatePredictionResultRequest, ServerCallContext)

public virtual Task<Operation> UpdatePredictionResult(UpdatePredictionResultRequest request, ServerCallContext context)

Updates the parameters of a single PredictionResult.

Parameters
Name	Description
request	UpdatePredictionResultRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).