Class v1.AMLClient (0.3.0)

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

Package

@google-cloud/financialservices

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of AMLClient.

Parameters
Name Description
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new AMLClient({fallback: true}, gax); ```

Properties

aMLStub

aMLStub?: Promise<{
        [name: string]: Function;
    }>;

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

backtestResultPath(projectNum, location, instance, backtestResult)

backtestResultPath(projectNum: string, location: string, instance: string, backtestResult: string): string;

Return a fully-qualified backtestResult resource name string.

Parameters
Name Description
projectNum string
location string
instance string
backtestResult string
Returns
Type Description
string

{string} Resource name string.

cancelOperation(request, optionsOrCallback, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

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 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 value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request CancelOperationRequest

The request object that will be sent.
optionsOrCallback CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
callback Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example 

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateBacktestResultProgress(name)

checkCreateBacktestResultProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.BacktestResult, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by createBacktestResult().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.BacktestResult, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the BacktestResult is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource id of the BacktestResult
   */
  // const backtestResultId = 'abc123'
  /**
   *  Required. The BacktestResult that will be created.
   */
  // const backtestResult = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callCreateBacktestResult() {
    // Construct request
    const request = {
      parent,
      backtestResultId,
      backtestResult,
    };

    // Run request
    const [operation] = await financialservicesClient.createBacktestResult(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateBacktestResult();

checkCreateDatasetProgress(name)

checkCreateDatasetProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.Dataset, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by createDataset().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.Dataset, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the Dataset is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource id of the dataset
   */
  // const datasetId = 'abc123'
  /**
   *  Required. The dataset that will be created.
   */
  // const dataset = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callCreateDataset() {
    // Construct request
    const request = {
      parent,
      datasetId,
      dataset,
    };

    // Run request
    const [operation] = await financialservicesClient.createDataset(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateDataset();

checkCreateEngineConfigProgress(name)

checkCreateEngineConfigProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.EngineConfig, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by createEngineConfig().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.EngineConfig, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the EngineConfig is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource id of the EngineConfig
   */
  // const engineConfigId = 'abc123'
  /**
   *  Required. The EngineConfig that will be created.
   */
  // const engineConfig = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callCreateEngineConfig() {
    // Construct request
    const request = {
      parent,
      engineConfigId,
      engineConfig,
    };

    // Run request
    const [operation] = await financialservicesClient.createEngineConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateEngineConfig();

checkCreateInstanceProgress(name)

checkCreateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.Instance, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by createInstance().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.Instance, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the Instance is the location for that Instance.
   *  Every location has exactly one instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource id of the instance.
   */
  // const instanceId = 'abc123'
  /**
   *  Required. The instance that will be created.
   */
  // const instance = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callCreateInstance() {
    // Construct request
    const request = {
      parent,
      instanceId,
      instance,
    };

    // Run request
    const [operation] = await financialservicesClient.createInstance(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateInstance();

checkCreateModelProgress(name)

checkCreateModelProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.Model, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by createModel().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.Model, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the Model is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource id of the Model
   */
  // const modelId = 'abc123'
  /**
   *  Required. The Model that will be created.
   */
  // const model = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callCreateModel() {
    // Construct request
    const request = {
      parent,
      modelId,
      model,
    };

    // Run request
    const [operation] = await financialservicesClient.createModel(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateModel();

checkCreatePredictionResultProgress(name)

checkCreatePredictionResultProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.PredictionResult, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by createPredictionResult().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.PredictionResult, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the PredictionResult is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource id of the PredictionResult
   */
  // const predictionResultId = 'abc123'
  /**
   *  Required. The PredictionResult that will be created.
   */
  // const predictionResult = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callCreatePredictionResult() {
    // Construct request
    const request = {
      parent,
      predictionResultId,
      predictionResult,
    };

    // Run request
    const [operation] = await financialservicesClient.createPredictionResult(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreatePredictionResult();

checkDeleteBacktestResultProgress(name)

checkDeleteBacktestResultProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by deleteBacktestResult().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the BacktestResult.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callDeleteBacktestResult() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await financialservicesClient.deleteBacktestResult(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteBacktestResult();

checkDeleteDatasetProgress(name)

checkDeleteDatasetProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by deleteDataset().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Dataset.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callDeleteDataset() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await financialservicesClient.deleteDataset(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteDataset();

checkDeleteEngineConfigProgress(name)

checkDeleteEngineConfigProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by deleteEngineConfig().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the EngineConfig.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callDeleteEngineConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await financialservicesClient.deleteEngineConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteEngineConfig();

checkDeleteInstanceProgress(name)

checkDeleteInstanceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by deleteInstance().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Instance.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callDeleteInstance() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await financialservicesClient.deleteInstance(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteInstance();

checkDeleteModelProgress(name)

checkDeleteModelProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by deleteModel().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Model.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callDeleteModel() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await financialservicesClient.deleteModel(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteModel();

checkDeletePredictionResultProgress(name)

checkDeletePredictionResultProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by deletePredictionResult().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the PredictionResult.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callDeletePredictionResult() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await financialservicesClient.deletePredictionResult(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeletePredictionResult();

checkExportBacktestResultMetadataProgress(name)

checkExportBacktestResultMetadataProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.ExportBacktestResultMetadataResponse, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by exportBacktestResultMetadata().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.ExportBacktestResultMetadataResponse, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the BacktestResult.
   */
  // const backtestResult = 'abc123'
  /**
   *  Required. BigQuery output where the metadata will be written.
   */
  // const structuredMetadataDestination = {}

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callExportBacktestResultMetadata() {
    // Construct request
    const request = {
      backtestResult,
      structuredMetadataDestination,
    };

    // Run request
    const [operation] = await financialservicesClient.exportBacktestResultMetadata(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportBacktestResultMetadata();

checkExportEngineConfigMetadataProgress(name)

checkExportEngineConfigMetadataProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.ExportEngineConfigMetadataResponse, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by exportEngineConfigMetadata().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.ExportEngineConfigMetadataResponse, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the EngineConfig.
   */
  // const engineConfig = 'abc123'
  /**
   *  Required. BigQuery output where the metadata will be written.
   */
  // const structuredMetadataDestination = {}

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callExportEngineConfigMetadata() {
    // Construct request
    const request = {
      engineConfig,
      structuredMetadataDestination,
    };

    // Run request
    const [operation] = await financialservicesClient.exportEngineConfigMetadata(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportEngineConfigMetadata();

checkExportModelMetadataProgress(name)

checkExportModelMetadataProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.ExportModelMetadataResponse, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by exportModelMetadata().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.ExportModelMetadataResponse, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Model.
   */
  // const model = 'abc123'
  /**
   *  Required. BigQuery output where the metadata will be written.
   */
  // const structuredMetadataDestination = {}

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callExportModelMetadata() {
    // Construct request
    const request = {
      model,
      structuredMetadataDestination,
    };

    // Run request
    const [operation] = await financialservicesClient.exportModelMetadata(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportModelMetadata();

checkExportPredictionResultMetadataProgress(name)

checkExportPredictionResultMetadataProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.ExportPredictionResultMetadataResponse, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by exportPredictionResultMetadata().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.ExportPredictionResultMetadataResponse, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the PredictionResult.
   */
  // const predictionResult = 'abc123'
  /**
   *  Required. BigQuery output where the metadata will be written.
   */
  // const structuredMetadataDestination = {}

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callExportPredictionResultMetadata() {
    // Construct request
    const request = {
      predictionResult,
      structuredMetadataDestination,
    };

    // Run request
    const [operation] = await financialservicesClient.exportPredictionResultMetadata(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportPredictionResultMetadata();

checkExportRegisteredPartiesProgress(name)

checkExportRegisteredPartiesProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.ExportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by exportRegisteredParties().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.ExportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The full path to the Instance resource in this API.
   *  format: `projects/{project}/locations/{location}/instances/{instance}`
   */
  // const name = 'abc123'
  /**
   *  Required. The location to output the RegisteredParties.
   */
  // const dataset = {}
  /**
   *  Required. LineOfBusiness to get RegisteredParties from.
   */
  // const lineOfBusiness = {}

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callExportRegisteredParties() {
    // Construct request
    const request = {
      name,
      dataset,
      lineOfBusiness,
    };

    // Run request
    const [operation] = await financialservicesClient.exportRegisteredParties(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportRegisteredParties();

checkImportRegisteredPartiesProgress(name)

checkImportRegisteredPartiesProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.ImportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by importRegisteredParties().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.ImportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The full path to the Instance resource in this API.
   *  format: `projects/{project}/locations/{location}/instances/{instance}`
   */
  // const name = 'abc123'
  /**
   *  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
   */
  // const partyTables = ['abc','def']
  /**
   *  Required. Mode of the request.
   */
  // const mode = {}
  /**
   *  Optional. If the request will not register the parties, just determine what
   *  would happen.
   */
  // const validateOnly = true
  /**
   *  Required. LineOfBusiness for the specified registered parties.
   */
  // const lineOfBusiness = {}

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callImportRegisteredParties() {
    // Construct request
    const request = {
      name,
      mode,
      lineOfBusiness,
    };

    // Run request
    const [operation] = await financialservicesClient.importRegisteredParties(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callImportRegisteredParties();

checkUpdateBacktestResultProgress(name)

checkUpdateBacktestResultProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.BacktestResult, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by updateBacktestResult().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.BacktestResult, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const updateMask = {}
  /**
   *  Required. The new value of the BacktestResult fields that will be updated
   *  according to the update_mask.
   */
  // const backtestResult = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callUpdateBacktestResult() {
    // Construct request
    const request = {
      backtestResult,
    };

    // Run request
    const [operation] = await financialservicesClient.updateBacktestResult(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateBacktestResult();

checkUpdateDatasetProgress(name)

checkUpdateDatasetProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.Dataset, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by updateDataset().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.Dataset, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const updateMask = {}
  /**
   *  Required. The new value of the dataset fields that will be updated
   *  according to the update_mask.
   */
  // const dataset = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callUpdateDataset() {
    // Construct request
    const request = {
      dataset,
    };

    // Run request
    const [operation] = await financialservicesClient.updateDataset(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateDataset();

checkUpdateEngineConfigProgress(name)

checkUpdateEngineConfigProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.EngineConfig, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by updateEngineConfig().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.EngineConfig, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const updateMask = {}
  /**
   *  Required. The new value of the EngineConfig fields that will be updated
   *  according to the update_mask.
   */
  // const engineConfig = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callUpdateEngineConfig() {
    // Construct request
    const request = {
      engineConfig,
    };

    // Run request
    const [operation] = await financialservicesClient.updateEngineConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateEngineConfig();

checkUpdateInstanceProgress(name)

checkUpdateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.Instance, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by updateInstance().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.Instance, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const updateMask = {}
  /**
   *  Required. The new value of the instance fields that will be updated
   *  according to the update_mask
   */
  // const instance = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callUpdateInstance() {
    // Construct request
    const request = {
      instance,
    };

    // Run request
    const [operation] = await financialservicesClient.updateInstance(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateInstance();

checkUpdateModelProgress(name)

checkUpdateModelProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.Model, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by updateModel().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.Model, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const updateMask = {}
  /**
   *  Required. The new value of the Model fields that will be updated according
   *  to the update_mask.
   */
  // const model = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callUpdateModel() {
    // Construct request
    const request = {
      model,
    };

    // Run request
    const [operation] = await financialservicesClient.updateModel(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateModel();

checkUpdatePredictionResultProgress(name)

checkUpdatePredictionResultProgress(name: string): Promise<LROperation<protos.google.cloud.financialservices.v1.PredictionResult, protos.google.cloud.financialservices.v1.OperationMetadata>>;

Check the status of the long running operation returned by updatePredictionResult().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.financialservices.v1.PredictionResult, protos.google.cloud.financialservices.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const updateMask = {}
  /**
   *  Required. The new value of the PredictionResult fields that will be updated
   *  according to the update_mask.
   */
  // const predictionResult = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callUpdatePredictionResult() {
    // Construct request
    const request = {
      predictionResult,
    };

    // Run request
    const [operation] = await financialservicesClient.updatePredictionResult(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdatePredictionResult();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

createBacktestResult(request, options)

createBacktestResult(request?: protos.google.cloud.financialservices.v1.ICreateBacktestResultRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Create a BacktestResult.

Parameters
Name Description
request ICreateBacktestResultRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the BacktestResult is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource id of the BacktestResult
   */
  // const backtestResultId = 'abc123'
  /**
   *  Required. The BacktestResult that will be created.
   */
  // const backtestResult = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callCreateBacktestResult() {
    // Construct request
    const request = {
      parent,
      backtestResultId,
      backtestResult,
    };

    // Run request
    const [operation] = await financialservicesClient.createBacktestResult(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateBacktestResult();

createBacktestResult(request, options, callback)

createBacktestResult(request: protos.google.cloud.financialservices.v1.ICreateBacktestResultRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateBacktestResultRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createBacktestResult(request, callback)

createBacktestResult(request: protos.google.cloud.financialservices.v1.ICreateBacktestResultRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateBacktestResultRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDataset(request, options)

createDataset(request?: protos.google.cloud.financialservices.v1.ICreateDatasetRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a dataset.

Parameters
Name Description
request ICreateDatasetRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the Dataset is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource id of the dataset
   */
  // const datasetId = 'abc123'
  /**
   *  Required. The dataset that will be created.
   */
  // const dataset = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callCreateDataset() {
    // Construct request
    const request = {
      parent,
      datasetId,
      dataset,
    };

    // Run request
    const [operation] = await financialservicesClient.createDataset(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateDataset();

createDataset(request, options, callback)

createDataset(request: protos.google.cloud.financialservices.v1.ICreateDatasetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDatasetRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createDataset(request, callback)

createDataset(request: protos.google.cloud.financialservices.v1.ICreateDatasetRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateDatasetRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createEngineConfig(request, options)

createEngineConfig(request?: protos.google.cloud.financialservices.v1.ICreateEngineConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates an engine config.

Parameters
Name Description
request ICreateEngineConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the EngineConfig is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource id of the EngineConfig
   */
  // const engineConfigId = 'abc123'
  /**
   *  Required. The EngineConfig that will be created.
   */
  // const engineConfig = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callCreateEngineConfig() {
    // Construct request
    const request = {
      parent,
      engineConfigId,
      engineConfig,
    };

    // Run request
    const [operation] = await financialservicesClient.createEngineConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateEngineConfig();

createEngineConfig(request, options, callback)

createEngineConfig(request: protos.google.cloud.financialservices.v1.ICreateEngineConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateEngineConfigRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createEngineConfig(request, callback)

createEngineConfig(request: protos.google.cloud.financialservices.v1.ICreateEngineConfigRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateEngineConfigRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInstance(request, options)

createInstance(request?: protos.google.cloud.financialservices.v1.ICreateInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates an instance.

Parameters
Name Description
request ICreateInstanceRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the Instance is the location for that Instance.
   *  Every location has exactly one instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource id of the instance.
   */
  // const instanceId = 'abc123'
  /**
   *  Required. The instance that will be created.
   */
  // const instance = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callCreateInstance() {
    // Construct request
    const request = {
      parent,
      instanceId,
      instance,
    };

    // Run request
    const [operation] = await financialservicesClient.createInstance(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateInstance();

createInstance(request, options, callback)

createInstance(request: protos.google.cloud.financialservices.v1.ICreateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInstance(request, callback)

createInstance(request: protos.google.cloud.financialservices.v1.ICreateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateInstanceRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createModel(request, options)

createModel(request?: protos.google.cloud.financialservices.v1.ICreateModelRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a model.

Parameters
Name Description
request ICreateModelRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the Model is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource id of the Model
   */
  // const modelId = 'abc123'
  /**
   *  Required. The Model that will be created.
   */
  // const model = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callCreateModel() {
    // Construct request
    const request = {
      parent,
      modelId,
      model,
    };

    // Run request
    const [operation] = await financialservicesClient.createModel(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateModel();

createModel(request, options, callback)

createModel(request: protos.google.cloud.financialservices.v1.ICreateModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateModelRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createModel(request, callback)

createModel(request: protos.google.cloud.financialservices.v1.ICreateModelRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateModelRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createPredictionResult(request, options)

createPredictionResult(request?: protos.google.cloud.financialservices.v1.ICreatePredictionResultRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Create a PredictionResult.

Parameters
Name Description
request ICreatePredictionResultRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the PredictionResult is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource id of the PredictionResult
   */
  // const predictionResultId = 'abc123'
  /**
   *  Required. The PredictionResult that will be created.
   */
  // const predictionResult = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callCreatePredictionResult() {
    // Construct request
    const request = {
      parent,
      predictionResultId,
      predictionResult,
    };

    // Run request
    const [operation] = await financialservicesClient.createPredictionResult(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreatePredictionResult();

createPredictionResult(request, options, callback)

createPredictionResult(request: protos.google.cloud.financialservices.v1.ICreatePredictionResultRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreatePredictionResultRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createPredictionResult(request, callback)

createPredictionResult(request: protos.google.cloud.financialservices.v1.ICreatePredictionResultRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreatePredictionResultRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

datasetPath(projectNum, location, instance, dataset)

datasetPath(projectNum: string, location: string, instance: string, dataset: string): string;

Return a fully-qualified dataset resource name string.

Parameters
Name Description
projectNum string
location string
instance string
dataset string
Returns
Type Description
string

{string} Resource name string.

deleteBacktestResult(request, options)

deleteBacktestResult(request?: protos.google.cloud.financialservices.v1.IDeleteBacktestResultRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a BacktestResult.

Parameters
Name Description
request IDeleteBacktestResultRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the BacktestResult.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callDeleteBacktestResult() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await financialservicesClient.deleteBacktestResult(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteBacktestResult();

deleteBacktestResult(request, options, callback)

deleteBacktestResult(request: protos.google.cloud.financialservices.v1.IDeleteBacktestResultRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteBacktestResultRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteBacktestResult(request, callback)

deleteBacktestResult(request: protos.google.cloud.financialservices.v1.IDeleteBacktestResultRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteBacktestResultRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDataset(request, options)

deleteDataset(request?: protos.google.cloud.financialservices.v1.IDeleteDatasetRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a dataset.

Parameters
Name Description
request IDeleteDatasetRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Dataset.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callDeleteDataset() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await financialservicesClient.deleteDataset(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteDataset();

deleteDataset(request, options, callback)

deleteDataset(request: protos.google.cloud.financialservices.v1.IDeleteDatasetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDatasetRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteDataset(request, callback)

deleteDataset(request: protos.google.cloud.financialservices.v1.IDeleteDatasetRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteDatasetRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteEngineConfig(request, options)

deleteEngineConfig(request?: protos.google.cloud.financialservices.v1.IDeleteEngineConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes an engine config.

Parameters
Name Description
request IDeleteEngineConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the EngineConfig.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callDeleteEngineConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await financialservicesClient.deleteEngineConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteEngineConfig();

deleteEngineConfig(request, options, callback)

deleteEngineConfig(request: protos.google.cloud.financialservices.v1.IDeleteEngineConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteEngineConfigRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteEngineConfig(request, callback)

deleteEngineConfig(request: protos.google.cloud.financialservices.v1.IDeleteEngineConfigRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteEngineConfigRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteInstance(request, options)

deleteInstance(request?: protos.google.cloud.financialservices.v1.IDeleteInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes an instance.

Parameters
Name Description
request IDeleteInstanceRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Instance.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callDeleteInstance() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await financialservicesClient.deleteInstance(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteInstance();

deleteInstance(request, options, callback)

deleteInstance(request: protos.google.cloud.financialservices.v1.IDeleteInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteInstance(request, callback)

deleteInstance(request: protos.google.cloud.financialservices.v1.IDeleteInstanceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteInstanceRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteModel(request, options)

deleteModel(request?: protos.google.cloud.financialservices.v1.IDeleteModelRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a model.

Parameters
Name Description
request IDeleteModelRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Model.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callDeleteModel() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await financialservicesClient.deleteModel(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteModel();

deleteModel(request, options, callback)

deleteModel(request: protos.google.cloud.financialservices.v1.IDeleteModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteModelRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteModel(request, callback)

deleteModel(request: protos.google.cloud.financialservices.v1.IDeleteModelRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteModelRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteOperation(request, optionsOrCallback, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

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 DeleteOperationRequest

The request object that will be sent.
optionsOrCallback CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
callback Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example 

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

deletePredictionResult(request, options)

deletePredictionResult(request?: protos.google.cloud.financialservices.v1.IDeletePredictionResultRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a PredictionResult.

Parameters
Name Description
request IDeletePredictionResultRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the PredictionResult.
   */
  // const name = 'abc123'
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callDeletePredictionResult() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await financialservicesClient.deletePredictionResult(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeletePredictionResult();

deletePredictionResult(request, options, callback)

deletePredictionResult(request: protos.google.cloud.financialservices.v1.IDeletePredictionResultRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeletePredictionResultRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deletePredictionResult(request, callback)

deletePredictionResult(request: protos.google.cloud.financialservices.v1.IDeletePredictionResultRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeletePredictionResultRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

engineConfigPath(projectNum, location, instance, engineConfig)

engineConfigPath(projectNum: string, location: string, instance: string, engineConfig: string): string;

Return a fully-qualified engineConfig resource name string.

Parameters
Name Description
projectNum string
location string
instance string
engineConfig string
Returns
Type Description
string

{string} Resource name string.

engineVersionPath(projectNum, location, instance, engineVersion)

engineVersionPath(projectNum: string, location: string, instance: string, engineVersion: string): string;

Return a fully-qualified engineVersion resource name string.

Parameters
Name Description
projectNum string
location string
instance string
engineVersion string
Returns
Type Description
string

{string} Resource name string.

exportBacktestResultMetadata(request, options)

exportBacktestResultMetadata(request?: protos.google.cloud.financialservices.v1.IExportBacktestResultMetadataRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IExportBacktestResultMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Export governance information for a BacktestResult resource. For information on the exported fields, see [AML output data model](https://cloud.google.com/financial-services/anti-money-laundering/docs/reference/schemas/aml-output-data-model#backtest-results).

Parameters
Name Description
request IExportBacktestResultMetadataRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IExportBacktestResultMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the BacktestResult.
   */
  // const backtestResult = 'abc123'
  /**
   *  Required. BigQuery output where the metadata will be written.
   */
  // const structuredMetadataDestination = {}

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callExportBacktestResultMetadata() {
    // Construct request
    const request = {
      backtestResult,
      structuredMetadataDestination,
    };

    // Run request
    const [operation] = await financialservicesClient.exportBacktestResultMetadata(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportBacktestResultMetadata();

exportBacktestResultMetadata(request, options, callback)

exportBacktestResultMetadata(request: protos.google.cloud.financialservices.v1.IExportBacktestResultMetadataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IExportBacktestResultMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportBacktestResultMetadataRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IExportBacktestResultMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportBacktestResultMetadata(request, callback)

exportBacktestResultMetadata(request: protos.google.cloud.financialservices.v1.IExportBacktestResultMetadataRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IExportBacktestResultMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportBacktestResultMetadataRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IExportBacktestResultMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportEngineConfigMetadata(request, options)

exportEngineConfigMetadata(request?: protos.google.cloud.financialservices.v1.IExportEngineConfigMetadataRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IExportEngineConfigMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Export governance information for an EngineConfig resource. For information on the exported fields, see [AML output data model](https://cloud.google.com/financial-services/anti-money-laundering/docs/reference/schemas/aml-output-data-model#engine-config).

Parameters
Name Description
request IExportEngineConfigMetadataRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IExportEngineConfigMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the EngineConfig.
   */
  // const engineConfig = 'abc123'
  /**
   *  Required. BigQuery output where the metadata will be written.
   */
  // const structuredMetadataDestination = {}

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callExportEngineConfigMetadata() {
    // Construct request
    const request = {
      engineConfig,
      structuredMetadataDestination,
    };

    // Run request
    const [operation] = await financialservicesClient.exportEngineConfigMetadata(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportEngineConfigMetadata();

exportEngineConfigMetadata(request, options, callback)

exportEngineConfigMetadata(request: protos.google.cloud.financialservices.v1.IExportEngineConfigMetadataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IExportEngineConfigMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportEngineConfigMetadataRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IExportEngineConfigMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportEngineConfigMetadata(request, callback)

exportEngineConfigMetadata(request: protos.google.cloud.financialservices.v1.IExportEngineConfigMetadataRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IExportEngineConfigMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportEngineConfigMetadataRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IExportEngineConfigMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportModelMetadata(request, options)

exportModelMetadata(request?: protos.google.cloud.financialservices.v1.IExportModelMetadataRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IExportModelMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Export governance information for a Model resource. For information on the exported fields, see [AML output data model](https://cloud.google.com/financial-services/anti-money-laundering/docs/reference/schemas/aml-output-data-model#model).

Parameters
Name Description
request IExportModelMetadataRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IExportModelMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Model.
   */
  // const model = 'abc123'
  /**
   *  Required. BigQuery output where the metadata will be written.
   */
  // const structuredMetadataDestination = {}

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callExportModelMetadata() {
    // Construct request
    const request = {
      model,
      structuredMetadataDestination,
    };

    // Run request
    const [operation] = await financialservicesClient.exportModelMetadata(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportModelMetadata();

exportModelMetadata(request, options, callback)

exportModelMetadata(request: protos.google.cloud.financialservices.v1.IExportModelMetadataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IExportModelMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportModelMetadataRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IExportModelMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportModelMetadata(request, callback)

exportModelMetadata(request: protos.google.cloud.financialservices.v1.IExportModelMetadataRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IExportModelMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportModelMetadataRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IExportModelMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportPredictionResultMetadata(request, options)

exportPredictionResultMetadata(request?: protos.google.cloud.financialservices.v1.IExportPredictionResultMetadataRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IExportPredictionResultMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Export governance information for a PredictionResult resource. For information on the exported fields, see [AML output data model](https://cloud.google.com/financial-services/anti-money-laundering/docs/reference/schemas/aml-output-data-model#prediction-results).

Parameters
Name Description
request IExportPredictionResultMetadataRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IExportPredictionResultMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the PredictionResult.
   */
  // const predictionResult = 'abc123'
  /**
   *  Required. BigQuery output where the metadata will be written.
   */
  // const structuredMetadataDestination = {}

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callExportPredictionResultMetadata() {
    // Construct request
    const request = {
      predictionResult,
      structuredMetadataDestination,
    };

    // Run request
    const [operation] = await financialservicesClient.exportPredictionResultMetadata(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportPredictionResultMetadata();

exportPredictionResultMetadata(request, options, callback)

exportPredictionResultMetadata(request: protos.google.cloud.financialservices.v1.IExportPredictionResultMetadataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IExportPredictionResultMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportPredictionResultMetadataRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IExportPredictionResultMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportPredictionResultMetadata(request, callback)

exportPredictionResultMetadata(request: protos.google.cloud.financialservices.v1.IExportPredictionResultMetadataRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IExportPredictionResultMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportPredictionResultMetadataRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IExportPredictionResultMetadataResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportRegisteredParties(request, options)

exportRegisteredParties(request?: protos.google.cloud.financialservices.v1.IExportRegisteredPartiesRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IExportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Exports the list of registered parties. See [Create and manage instances](https://cloud.google.com/financial-services/anti-money-laundering/docs/create-and-manage-instances#export-registered-parties) for information on the output schema for this method.

Parameters
Name Description
request IExportRegisteredPartiesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IExportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The full path to the Instance resource in this API.
   *  format: `projects/{project}/locations/{location}/instances/{instance}`
   */
  // const name = 'abc123'
  /**
   *  Required. The location to output the RegisteredParties.
   */
  // const dataset = {}
  /**
   *  Required. LineOfBusiness to get RegisteredParties from.
   */
  // const lineOfBusiness = {}

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callExportRegisteredParties() {
    // Construct request
    const request = {
      name,
      dataset,
      lineOfBusiness,
    };

    // Run request
    const [operation] = await financialservicesClient.exportRegisteredParties(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportRegisteredParties();

exportRegisteredParties(request, options, callback)

exportRegisteredParties(request: protos.google.cloud.financialservices.v1.IExportRegisteredPartiesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IExportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportRegisteredPartiesRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IExportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportRegisteredParties(request, callback)

exportRegisteredParties(request: protos.google.cloud.financialservices.v1.IExportRegisteredPartiesRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IExportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExportRegisteredPartiesRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IExportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

getBacktestResult(request, options)

getBacktestResult(request?: protos.google.cloud.financialservices.v1.IGetBacktestResultRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IBacktestResult,
        protos.google.cloud.financialservices.v1.IGetBacktestResultRequest | undefined,
        {} | undefined
    ]>;

Gets a BacktestResult.

Parameters
Name Description
request IGetBacktestResultRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IGetBacktestResultRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the BacktestResult
   */
  // const name = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callGetBacktestResult() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await financialservicesClient.getBacktestResult(request);
    console.log(response);
  }

  callGetBacktestResult();

getBacktestResult(request, options, callback)

getBacktestResult(request: protos.google.cloud.financialservices.v1.IGetBacktestResultRequest, options: CallOptions, callback: Callback<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IGetBacktestResultRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetBacktestResultRequest
options CallOptions
callback Callback<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IGetBacktestResultRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getBacktestResult(request, callback)

getBacktestResult(request: protos.google.cloud.financialservices.v1.IGetBacktestResultRequest, callback: Callback<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IGetBacktestResultRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetBacktestResultRequest
callback Callback<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IGetBacktestResultRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDataset(request, options)

getDataset(request?: protos.google.cloud.financialservices.v1.IGetDatasetRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IDataset,
        protos.google.cloud.financialservices.v1.IGetDatasetRequest | undefined,
        {} | undefined
    ]>;

Gets a dataset.

Parameters
Name Description
request IGetDatasetRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IGetDatasetRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Dataset
   */
  // const name = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callGetDataset() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await financialservicesClient.getDataset(request);
    console.log(response);
  }

  callGetDataset();

getDataset(request, options, callback)

getDataset(request: protos.google.cloud.financialservices.v1.IGetDatasetRequest, options: CallOptions, callback: Callback<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IGetDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDatasetRequest
options CallOptions
callback Callback<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IGetDatasetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getDataset(request, callback)

getDataset(request: protos.google.cloud.financialservices.v1.IGetDatasetRequest, callback: Callback<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IGetDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetDatasetRequest
callback Callback<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IGetDatasetRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEngineConfig(request, options)

getEngineConfig(request?: protos.google.cloud.financialservices.v1.IGetEngineConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IEngineConfig,
        protos.google.cloud.financialservices.v1.IGetEngineConfigRequest | undefined,
        {} | undefined
    ]>;

Gets an engine config.

Parameters
Name Description
request IGetEngineConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IGetEngineConfigRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the EngineConfig
   */
  // const name = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callGetEngineConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await financialservicesClient.getEngineConfig(request);
    console.log(response);
  }

  callGetEngineConfig();

getEngineConfig(request, options, callback)

getEngineConfig(request: protos.google.cloud.financialservices.v1.IGetEngineConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IGetEngineConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEngineConfigRequest
options CallOptions
callback Callback<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IGetEngineConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEngineConfig(request, callback)

getEngineConfig(request: protos.google.cloud.financialservices.v1.IGetEngineConfigRequest, callback: Callback<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IGetEngineConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEngineConfigRequest
callback Callback<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IGetEngineConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEngineVersion(request, options)

getEngineVersion(request?: protos.google.cloud.financialservices.v1.IGetEngineVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IEngineVersion,
        protos.google.cloud.financialservices.v1.IGetEngineVersionRequest | undefined,
        {} | undefined
    ]>;

Gets a single EngineVersion.

Parameters
Name Description
request IGetEngineVersionRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IEngineVersion, protos.google.cloud.financialservices.v1.IGetEngineVersionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the EngineVersion
   */
  // const name = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callGetEngineVersion() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await financialservicesClient.getEngineVersion(request);
    console.log(response);
  }

  callGetEngineVersion();

getEngineVersion(request, options, callback)

getEngineVersion(request: protos.google.cloud.financialservices.v1.IGetEngineVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.financialservices.v1.IEngineVersion, protos.google.cloud.financialservices.v1.IGetEngineVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEngineVersionRequest
options CallOptions
callback Callback<protos.google.cloud.financialservices.v1.IEngineVersion, protos.google.cloud.financialservices.v1.IGetEngineVersionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEngineVersion(request, callback)

getEngineVersion(request: protos.google.cloud.financialservices.v1.IGetEngineVersionRequest, callback: Callback<protos.google.cloud.financialservices.v1.IEngineVersion, protos.google.cloud.financialservices.v1.IGetEngineVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEngineVersionRequest
callback Callback<protos.google.cloud.financialservices.v1.IEngineVersion, protos.google.cloud.financialservices.v1.IGetEngineVersionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInstance(request, options)

getInstance(request?: protos.google.cloud.financialservices.v1.IGetInstanceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IInstance,
        protos.google.cloud.financialservices.v1.IGetInstanceRequest | undefined,
        {} | undefined
    ]>;

Gets an instance.

Parameters
Name Description
request IGetInstanceRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IGetInstanceRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Instance.
   */
  // const name = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callGetInstance() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await financialservicesClient.getInstance(request);
    console.log(response);
  }

  callGetInstance();

getInstance(request, options, callback)

getInstance(request: protos.google.cloud.financialservices.v1.IGetInstanceRequest, options: CallOptions, callback: Callback<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetInstanceRequest
options CallOptions
callback Callback<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInstance(request, callback)

getInstance(request: protos.google.cloud.financialservices.v1.IGetInstanceRequest, callback: Callback<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetInstanceRequest
callback Callback<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name Description
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.
options CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.
callback Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
Promise<google.cloud.location.ILocation>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

const [response] = await client.getLocation(request);

getModel(request, options)

getModel(request?: protos.google.cloud.financialservices.v1.IGetModelRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IModel,
        protos.google.cloud.financialservices.v1.IGetModelRequest | undefined,
        {} | undefined
    ]>;

Gets a model.

Parameters
Name Description
request IGetModelRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IGetModelRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Model
   */
  // const name = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callGetModel() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await financialservicesClient.getModel(request);
    console.log(response);
  }

  callGetModel();

getModel(request, options, callback)

getModel(request: protos.google.cloud.financialservices.v1.IGetModelRequest, options: CallOptions, callback: Callback<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IGetModelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetModelRequest
options CallOptions
callback Callback<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IGetModelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getModel(request, callback)

getModel(request: protos.google.cloud.financialservices.v1.IGetModelRequest, callback: Callback<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IGetModelRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetModelRequest
callback Callback<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IGetModelRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getOperation(request, optionsOrCallback, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

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 GetOperationRequest

The request object that will be sent.
optionsOrCallback CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
callback Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
Returns
Type Description
Promise<[protos.google.longrunning.Operation]>
Example 

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getPredictionResult(request, options)

getPredictionResult(request?: protos.google.cloud.financialservices.v1.IGetPredictionResultRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IPredictionResult,
        protos.google.cloud.financialservices.v1.IGetPredictionResultRequest | undefined,
        {} | undefined
    ]>;

Gets a PredictionResult.

Parameters
Name Description
request IGetPredictionResultRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IGetPredictionResultRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the PredictionResult
   */
  // const name = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callGetPredictionResult() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await financialservicesClient.getPredictionResult(request);
    console.log(response);
  }

  callGetPredictionResult();

getPredictionResult(request, options, callback)

getPredictionResult(request: protos.google.cloud.financialservices.v1.IGetPredictionResultRequest, options: CallOptions, callback: Callback<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IGetPredictionResultRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetPredictionResultRequest
options CallOptions
callback Callback<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IGetPredictionResultRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getPredictionResult(request, callback)

getPredictionResult(request: protos.google.cloud.financialservices.v1.IGetPredictionResultRequest, callback: Callback<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IGetPredictionResultRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetPredictionResultRequest
callback Callback<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IGetPredictionResultRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

importRegisteredParties(request, options)

importRegisteredParties(request?: protos.google.cloud.financialservices.v1.IImportRegisteredPartiesRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IImportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Imports the list of registered parties. See [Create and manage instances](https://cloud.google.com/financial-services/anti-money-laundering/docs/create-and-manage-instances#import-registered-parties) for information on the input schema and response for this method.

Parameters
Name Description
request IImportRegisteredPartiesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IImportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The full path to the Instance resource in this API.
   *  format: `projects/{project}/locations/{location}/instances/{instance}`
   */
  // const name = 'abc123'
  /**
   *  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
   */
  // const partyTables = ['abc','def']
  /**
   *  Required. Mode of the request.
   */
  // const mode = {}
  /**
   *  Optional. If the request will not register the parties, just determine what
   *  would happen.
   */
  // const validateOnly = true
  /**
   *  Required. LineOfBusiness for the specified registered parties.
   */
  // const lineOfBusiness = {}

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callImportRegisteredParties() {
    // Construct request
    const request = {
      name,
      mode,
      lineOfBusiness,
    };

    // Run request
    const [operation] = await financialservicesClient.importRegisteredParties(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callImportRegisteredParties();

importRegisteredParties(request, options, callback)

importRegisteredParties(request: protos.google.cloud.financialservices.v1.IImportRegisteredPartiesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IImportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IImportRegisteredPartiesRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IImportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

importRegisteredParties(request, callback)

importRegisteredParties(request: protos.google.cloud.financialservices.v1.IImportRegisteredPartiesRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IImportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IImportRegisteredPartiesRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IImportRegisteredPartiesResponse, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

instancePath(project, location, instance)

instancePath(project: string, location: string, instance: string): string;

Return a fully-qualified instance resource name string.

Parameters
Name Description
project string
location string
instance string
Returns
Type Description
string

{string} Resource name string.

listBacktestResults(request, options)

listBacktestResults(request?: protos.google.cloud.financialservices.v1.IListBacktestResultsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IBacktestResult[],
        protos.google.cloud.financialservices.v1.IListBacktestResultsRequest | null,
        protos.google.cloud.financialservices.v1.IListBacktestResultsResponse
    ]>;

List BacktestResults.

Parameters
Name Description
request IListBacktestResultsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IBacktestResult[], protos.google.cloud.financialservices.v1.IListBacktestResultsRequest | null, protos.google.cloud.financialservices.v1.IListBacktestResultsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listBacktestResultsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBacktestResults(request, options, callback)

listBacktestResults(request: protos.google.cloud.financialservices.v1.IListBacktestResultsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListBacktestResultsRequest, protos.google.cloud.financialservices.v1.IListBacktestResultsResponse | null | undefined, protos.google.cloud.financialservices.v1.IBacktestResult>): void;
Parameters
Name Description
request IListBacktestResultsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListBacktestResultsRequest, protos.google.cloud.financialservices.v1.IListBacktestResultsResponse | null | undefined, protos.google.cloud.financialservices.v1.IBacktestResult>
Returns
Type Description
void

listBacktestResults(request, callback)

listBacktestResults(request: protos.google.cloud.financialservices.v1.IListBacktestResultsRequest, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListBacktestResultsRequest, protos.google.cloud.financialservices.v1.IListBacktestResultsResponse | null | undefined, protos.google.cloud.financialservices.v1.IBacktestResult>): void;
Parameters
Name Description
request IListBacktestResultsRequest
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListBacktestResultsRequest, protos.google.cloud.financialservices.v1.IListBacktestResultsResponse | null | undefined, protos.google.cloud.financialservices.v1.IBacktestResult>
Returns
Type Description
void

listBacktestResultsAsync(request, options)

listBacktestResultsAsync(request?: protos.google.cloud.financialservices.v1.IListBacktestResultsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.financialservices.v1.IBacktestResult>;

Equivalent to listBacktestResults, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListBacktestResultsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.financialservices.v1.IBacktestResult>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the BacktestResult is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  The number of resources to be included in the response. The response
   *  contains a next_page_token, which can be used to retrieve the next page of
   *  resources.
   */
  // const pageSize = 1234
  /**
   *  In case of paginated results, this is the token that was returned in the
   *  previous ListBacktestResultsResponse. It should be copied here to
   *  retrieve the next page of resources. Empty will give the first page of
   *  ListBacktestResultsRequest, and the last page will return an empty
   *  page_token.
   */
  // const pageToken = 'abc123'
  /**
   *  Specify a filter to narrow search results.
   */
  // const filter = 'abc123'
  /**
   *  Specify a field to use for ordering.
   */
  // const orderBy = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callListBacktestResults() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = financialservicesClient.listBacktestResultsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListBacktestResults();

listBacktestResultsStream(request, options)

listBacktestResultsStream(request?: protos.google.cloud.financialservices.v1.IListBacktestResultsRequest, options?: CallOptions): Transform;

Equivalent to listBacktestResults, but returns a NodeJS Stream object.

Parameters
Name Description
request IListBacktestResultsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listBacktestResultsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDatasets(request, options)

listDatasets(request?: protos.google.cloud.financialservices.v1.IListDatasetsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IDataset[],
        protos.google.cloud.financialservices.v1.IListDatasetsRequest | null,
        protos.google.cloud.financialservices.v1.IListDatasetsResponse
    ]>;

Lists datasets.

Parameters
Name Description
request IListDatasetsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IDataset[], protos.google.cloud.financialservices.v1.IListDatasetsRequest | null, protos.google.cloud.financialservices.v1.IListDatasetsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDatasetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDatasets(request, options, callback)

listDatasets(request: protos.google.cloud.financialservices.v1.IListDatasetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListDatasetsRequest, protos.google.cloud.financialservices.v1.IListDatasetsResponse | null | undefined, protos.google.cloud.financialservices.v1.IDataset>): void;
Parameters
Name Description
request IListDatasetsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListDatasetsRequest, protos.google.cloud.financialservices.v1.IListDatasetsResponse | null | undefined, protos.google.cloud.financialservices.v1.IDataset>
Returns
Type Description
void

listDatasets(request, callback)

listDatasets(request: protos.google.cloud.financialservices.v1.IListDatasetsRequest, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListDatasetsRequest, protos.google.cloud.financialservices.v1.IListDatasetsResponse | null | undefined, protos.google.cloud.financialservices.v1.IDataset>): void;
Parameters
Name Description
request IListDatasetsRequest
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListDatasetsRequest, protos.google.cloud.financialservices.v1.IListDatasetsResponse | null | undefined, protos.google.cloud.financialservices.v1.IDataset>
Returns
Type Description
void

listDatasetsAsync(request, options)

listDatasetsAsync(request?: protos.google.cloud.financialservices.v1.IListDatasetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.financialservices.v1.IDataset>;

Equivalent to listDatasets, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListDatasetsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.financialservices.v1.IDataset>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the Dataset is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  The number of resources to be included in the response. The response
   *  contains a next_page_token, which can be used to retrieve the next page of
   *  resources.
   */
  // const pageSize = 1234
  /**
   *  In case of paginated results, this is the token that was returned in the
   *  previous ListDatasetResponse. It should be copied here to retrieve the
   *  next page of resources. Empty will give the first page of
   *  ListDatasetRequest, and the last page will return an empty page_token.
   */
  // const pageToken = 'abc123'
  /**
   *  Specify a filter to narrow search results.
   */
  // const filter = 'abc123'
  /**
   *  Specify a field to use for ordering.
   */
  // const orderBy = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callListDatasets() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = financialservicesClient.listDatasetsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListDatasets();

listDatasetsStream(request, options)

listDatasetsStream(request?: protos.google.cloud.financialservices.v1.IListDatasetsRequest, options?: CallOptions): Transform;

Equivalent to listDatasets, but returns a NodeJS Stream object.

Parameters
Name Description
request IListDatasetsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDatasetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEngineConfigs(request, options)

listEngineConfigs(request?: protos.google.cloud.financialservices.v1.IListEngineConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IEngineConfig[],
        protos.google.cloud.financialservices.v1.IListEngineConfigsRequest | null,
        protos.google.cloud.financialservices.v1.IListEngineConfigsResponse
    ]>;

Lists engine configs.

Parameters
Name Description
request IListEngineConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IEngineConfig[], protos.google.cloud.financialservices.v1.IListEngineConfigsRequest | null, protos.google.cloud.financialservices.v1.IListEngineConfigsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listEngineConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEngineConfigs(request, options, callback)

listEngineConfigs(request: protos.google.cloud.financialservices.v1.IListEngineConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListEngineConfigsRequest, protos.google.cloud.financialservices.v1.IListEngineConfigsResponse | null | undefined, protos.google.cloud.financialservices.v1.IEngineConfig>): void;
Parameters
Name Description
request IListEngineConfigsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListEngineConfigsRequest, protos.google.cloud.financialservices.v1.IListEngineConfigsResponse | null | undefined, protos.google.cloud.financialservices.v1.IEngineConfig>
Returns
Type Description
void

listEngineConfigs(request, callback)

listEngineConfigs(request: protos.google.cloud.financialservices.v1.IListEngineConfigsRequest, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListEngineConfigsRequest, protos.google.cloud.financialservices.v1.IListEngineConfigsResponse | null | undefined, protos.google.cloud.financialservices.v1.IEngineConfig>): void;
Parameters
Name Description
request IListEngineConfigsRequest
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListEngineConfigsRequest, protos.google.cloud.financialservices.v1.IListEngineConfigsResponse | null | undefined, protos.google.cloud.financialservices.v1.IEngineConfig>
Returns
Type Description
void

listEngineConfigsAsync(request, options)

listEngineConfigsAsync(request?: protos.google.cloud.financialservices.v1.IListEngineConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.financialservices.v1.IEngineConfig>;

Equivalent to listEngineConfigs, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListEngineConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.financialservices.v1.IEngineConfig>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the EngineConfig is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  The number of resources to be included in the response. The response
   *  contains a next_page_token, which can be used to retrieve the next page of
   *  resources.
   */
  // const pageSize = 1234
  /**
   *  In case of paginated results, this is the token that was returned in the
   *  previous ListEngineConfigsResponse. It should be copied here to retrieve
   *  the next page of resources. Empty will give the first page of
   *  ListEngineConfigsRequest, and the last page will return an empty
   *  page_token.
   */
  // const pageToken = 'abc123'
  /**
   *  Specify a filter to narrow search results.
   */
  // const filter = 'abc123'
  /**
   *  Specify a field to use for ordering.
   */
  // const orderBy = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callListEngineConfigs() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = financialservicesClient.listEngineConfigsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListEngineConfigs();

listEngineConfigsStream(request, options)

listEngineConfigsStream(request?: protos.google.cloud.financialservices.v1.IListEngineConfigsRequest, options?: CallOptions): Transform;

Equivalent to listEngineConfigs, but returns a NodeJS Stream object.

Parameters
Name Description
request IListEngineConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listEngineConfigsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEngineVersions(request, options)

listEngineVersions(request?: protos.google.cloud.financialservices.v1.IListEngineVersionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IEngineVersion[],
        protos.google.cloud.financialservices.v1.IListEngineVersionsRequest | null,
        protos.google.cloud.financialservices.v1.IListEngineVersionsResponse
    ]>;

Lists EngineVersions for given location.

Parameters
Name Description
request IListEngineVersionsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IEngineVersion[], protos.google.cloud.financialservices.v1.IListEngineVersionsRequest | null, protos.google.cloud.financialservices.v1.IListEngineVersionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listEngineVersionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEngineVersions(request, options, callback)

listEngineVersions(request: protos.google.cloud.financialservices.v1.IListEngineVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListEngineVersionsRequest, protos.google.cloud.financialservices.v1.IListEngineVersionsResponse | null | undefined, protos.google.cloud.financialservices.v1.IEngineVersion>): void;
Parameters
Name Description
request IListEngineVersionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListEngineVersionsRequest, protos.google.cloud.financialservices.v1.IListEngineVersionsResponse | null | undefined, protos.google.cloud.financialservices.v1.IEngineVersion>
Returns
Type Description
void

listEngineVersions(request, callback)

listEngineVersions(request: protos.google.cloud.financialservices.v1.IListEngineVersionsRequest, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListEngineVersionsRequest, protos.google.cloud.financialservices.v1.IListEngineVersionsResponse | null | undefined, protos.google.cloud.financialservices.v1.IEngineVersion>): void;
Parameters
Name Description
request IListEngineVersionsRequest
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListEngineVersionsRequest, protos.google.cloud.financialservices.v1.IListEngineVersionsResponse | null | undefined, protos.google.cloud.financialservices.v1.IEngineVersion>
Returns
Type Description
void

listEngineVersionsAsync(request, options)

listEngineVersionsAsync(request?: protos.google.cloud.financialservices.v1.IListEngineVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.financialservices.v1.IEngineVersion>;

Equivalent to listEngineVersions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListEngineVersionsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.financialservices.v1.IEngineVersion>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the EngineVersion is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The number of resources to be included in the response. The
   *  response contains a next_page_token, which can be used to retrieve the next
   *  page of resources.
   */
  // const pageSize = 1234
  /**
   *  Optional. In case of paginated results, this is the token that was returned
   *  in the previous ListEngineVersionsResponse. It should be copied here to
   *  retrieve the next page of resources. Empty will give the first page of
   *  ListEngineVersionsRequest, and the last page will return an empty
   *  page_token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Specify a filter to narrow search results.
   *  If empty or unset will default to "state!=DEPRECATED",
   *  to view deprecated versions use "state:*" or any other filter.
   */
  // const filter = 'abc123'
  /**
   *  Optional. Specify a field to use for ordering.
   */
  // const orderBy = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callListEngineVersions() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = financialservicesClient.listEngineVersionsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListEngineVersions();

listEngineVersionsStream(request, options)

listEngineVersionsStream(request?: protos.google.cloud.financialservices.v1.IListEngineVersionsRequest, options?: CallOptions): Transform;

Equivalent to listEngineVersions, but returns a NodeJS Stream object.

Parameters
Name Description
request IListEngineVersionsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listEngineVersionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInstances(request, options)

listInstances(request?: protos.google.cloud.financialservices.v1.IListInstancesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IInstance[],
        protos.google.cloud.financialservices.v1.IListInstancesRequest | null,
        protos.google.cloud.financialservices.v1.IListInstancesResponse
    ]>;

Lists instances.

Parameters
Name Description
request IListInstancesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IInstance[], protos.google.cloud.financialservices.v1.IListInstancesRequest | null, protos.google.cloud.financialservices.v1.IListInstancesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listInstancesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInstances(request, options, callback)

listInstances(request: protos.google.cloud.financialservices.v1.IListInstancesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListInstancesRequest, protos.google.cloud.financialservices.v1.IListInstancesResponse | null | undefined, protos.google.cloud.financialservices.v1.IInstance>): void;
Parameters
Name Description
request IListInstancesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListInstancesRequest, protos.google.cloud.financialservices.v1.IListInstancesResponse | null | undefined, protos.google.cloud.financialservices.v1.IInstance>
Returns
Type Description
void

listInstances(request, callback)

listInstances(request: protos.google.cloud.financialservices.v1.IListInstancesRequest, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListInstancesRequest, protos.google.cloud.financialservices.v1.IListInstancesResponse | null | undefined, protos.google.cloud.financialservices.v1.IInstance>): void;
Parameters
Name Description
request IListInstancesRequest
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListInstancesRequest, protos.google.cloud.financialservices.v1.IListInstancesResponse | null | undefined, protos.google.cloud.financialservices.v1.IInstance>
Returns
Type Description
void

listInstancesAsync(request, options)

listInstancesAsync(request?: protos.google.cloud.financialservices.v1.IListInstancesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.financialservices.v1.IInstance>;

Equivalent to listInstances, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListInstancesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.financialservices.v1.IInstance>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the Instance is the location for that Instance.
   *  Every location has exactly one instance.
   */
  // const parent = 'abc123'
  /**
   *  The number of resources to be included in the response. The response
   *  contains a next_page_token, which can be used to retrieve the next page of
   *  resources.
   */
  // const pageSize = 1234
  /**
   *  In case of paginated results, this is the token that was returned in the
   *  previous ListInstancesResponse. It should be copied here to retrieve the
   *  next page of resources. This will be empty for the first instance of
   *  ListInstancesRequest.
   */
  // const pageToken = 'abc123'
  /**
   *  Specify a filter to narrow search results.
   */
  // const filter = 'abc123'
  /**
   *  Specify a field to use for ordering.
   */
  // const orderBy = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callListInstances() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = financialservicesClient.listInstancesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListInstances();

listInstancesStream(request, options)

listInstancesStream(request?: protos.google.cloud.financialservices.v1.IListInstancesRequest, options?: CallOptions): Transform;

Equivalent to listInstances, but returns a NodeJS Stream object.

Parameters
Name Description
request IListInstancesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listInstancesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<google.cloud.location.ILocation>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example 

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listModels(request, options)

listModels(request?: protos.google.cloud.financialservices.v1.IListModelsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IModel[],
        protos.google.cloud.financialservices.v1.IListModelsRequest | null,
        protos.google.cloud.financialservices.v1.IListModelsResponse
    ]>;

Lists models.

Parameters
Name Description
request IListModelsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IModel[], protos.google.cloud.financialservices.v1.IListModelsRequest | null, protos.google.cloud.financialservices.v1.IListModelsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listModelsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listModels(request, options, callback)

listModels(request: protos.google.cloud.financialservices.v1.IListModelsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListModelsRequest, protos.google.cloud.financialservices.v1.IListModelsResponse | null | undefined, protos.google.cloud.financialservices.v1.IModel>): void;
Parameters
Name Description
request IListModelsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListModelsRequest, protos.google.cloud.financialservices.v1.IListModelsResponse | null | undefined, protos.google.cloud.financialservices.v1.IModel>
Returns
Type Description
void

listModels(request, callback)

listModels(request: protos.google.cloud.financialservices.v1.IListModelsRequest, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListModelsRequest, protos.google.cloud.financialservices.v1.IListModelsResponse | null | undefined, protos.google.cloud.financialservices.v1.IModel>): void;
Parameters
Name Description
request IListModelsRequest
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListModelsRequest, protos.google.cloud.financialservices.v1.IListModelsResponse | null | undefined, protos.google.cloud.financialservices.v1.IModel>
Returns
Type Description
void

listModelsAsync(request, options)

listModelsAsync(request?: protos.google.cloud.financialservices.v1.IListModelsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.financialservices.v1.IModel>;

Equivalent to listModels, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListModelsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.financialservices.v1.IModel>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the Model is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  The number of resources to be included in the response. The response
   *  contains a next_page_token, which can be used to retrieve the next page of
   *  resources.
   */
  // const pageSize = 1234
  /**
   *  In case of paginated results, this is the token that was returned in the
   *  previous ListModelsResponse. It should be copied here to retrieve the next
   *  page of resources. Empty will give the first page of ListModelsRequest, and
   *  the last page will return an empty page_token.
   */
  // const pageToken = 'abc123'
  /**
   *  Specify a filter to narrow search results.
   */
  // const filter = 'abc123'
  /**
   *  Specify a field to use for ordering.
   */
  // const orderBy = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callListModels() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = financialservicesClient.listModelsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListModels();

listModelsStream(request, options)

listModelsStream(request?: protos.google.cloud.financialservices.v1.IListModelsRequest, options?: CallOptions): Transform;

Equivalent to listModels, but returns a NodeJS Stream object.

Parameters
Name Description
request IListModelsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listModelsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name Description
request ListOperationsRequest

The request object that will be sent.
options CallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Returns
Type Description
AsyncIterable<protos.google.longrunning.IOperation>

{Object} An iterable Object that conforms to iteration protocols.
Example 

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

listPredictionResults(request, options)

listPredictionResults(request?: protos.google.cloud.financialservices.v1.IListPredictionResultsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.financialservices.v1.IPredictionResult[],
        protos.google.cloud.financialservices.v1.IListPredictionResultsRequest | null,
        protos.google.cloud.financialservices.v1.IListPredictionResultsResponse
    ]>;

List PredictionResults.

Parameters
Name Description
request IListPredictionResultsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.financialservices.v1.IPredictionResult[], protos.google.cloud.financialservices.v1.IListPredictionResultsRequest | null, protos.google.cloud.financialservices.v1.IListPredictionResultsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listPredictionResultsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listPredictionResults(request, options, callback)

listPredictionResults(request: protos.google.cloud.financialservices.v1.IListPredictionResultsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListPredictionResultsRequest, protos.google.cloud.financialservices.v1.IListPredictionResultsResponse | null | undefined, protos.google.cloud.financialservices.v1.IPredictionResult>): void;
Parameters
Name Description
request IListPredictionResultsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListPredictionResultsRequest, protos.google.cloud.financialservices.v1.IListPredictionResultsResponse | null | undefined, protos.google.cloud.financialservices.v1.IPredictionResult>
Returns
Type Description
void

listPredictionResults(request, callback)

listPredictionResults(request: protos.google.cloud.financialservices.v1.IListPredictionResultsRequest, callback: PaginationCallback<protos.google.cloud.financialservices.v1.IListPredictionResultsRequest, protos.google.cloud.financialservices.v1.IListPredictionResultsResponse | null | undefined, protos.google.cloud.financialservices.v1.IPredictionResult>): void;
Parameters
Name Description
request IListPredictionResultsRequest
callback PaginationCallback<protos.google.cloud.financialservices.v1.IListPredictionResultsRequest, protos.google.cloud.financialservices.v1.IListPredictionResultsResponse | null | undefined, protos.google.cloud.financialservices.v1.IPredictionResult>
Returns
Type Description
void

listPredictionResultsAsync(request, options)

listPredictionResultsAsync(request?: protos.google.cloud.financialservices.v1.IListPredictionResultsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.financialservices.v1.IPredictionResult>;

Equivalent to listPredictionResults, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListPredictionResultsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.financialservices.v1.IPredictionResult>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent of the PredictionResult is the Instance.
   */
  // const parent = 'abc123'
  /**
   *  The number of resources to be included in the response. The response
   *  contains a next_page_token, which can be used to retrieve the next page of
   *  resources.
   */
  // const pageSize = 1234
  /**
   *  In case of paginated results, this is the token that was returned in the
   *  previous ListPredictionResultsResponse. It should be copied here to
   *  retrieve the next page of resources. Empty will give the first page of
   *  ListPredictionResultsRequest, and the last page will return an empty
   *  page_token.
   */
  // const pageToken = 'abc123'
  /**
   *  Specify a filter to narrow search results.
   */
  // const filter = 'abc123'
  /**
   *  Specify a field to use for ordering.
   */
  // const orderBy = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callListPredictionResults() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = financialservicesClient.listPredictionResultsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListPredictionResults();

listPredictionResultsStream(request, options)

listPredictionResultsStream(request?: protos.google.cloud.financialservices.v1.IListPredictionResultsRequest, options?: CallOptions): Transform;

Equivalent to listPredictionResults, but returns a NodeJS Stream object.

Parameters
Name Description
request IListPredictionResultsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listPredictionResultsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchBacktestResultFromBacktestResultName(backtestResultName)

matchBacktestResultFromBacktestResultName(backtestResultName: string): string | number;

Parse the backtest_result from BacktestResult resource.

Parameter
Name Description
backtestResultName string

A fully-qualified path representing BacktestResult resource.
Returns
Type Description
string | number

{string} A string representing the backtest_result.

matchDatasetFromDatasetName(datasetName)

matchDatasetFromDatasetName(datasetName: string): string | number;

Parse the dataset from Dataset resource.

Parameter
Name Description
datasetName string

A fully-qualified path representing Dataset resource.
Returns
Type Description
string | number

{string} A string representing the dataset.

matchEngineConfigFromEngineConfigName(engineConfigName)

matchEngineConfigFromEngineConfigName(engineConfigName: string): string | number;

Parse the engine_config from EngineConfig resource.

Parameter
Name Description
engineConfigName string

A fully-qualified path representing EngineConfig resource.
Returns
Type Description
string | number

{string} A string representing the engine_config.

matchEngineVersionFromEngineVersionName(engineVersionName)

matchEngineVersionFromEngineVersionName(engineVersionName: string): string | number;

Parse the engine_version from EngineVersion resource.

Parameter
Name Description
engineVersionName string

A fully-qualified path representing EngineVersion resource.
Returns
Type Description
string | number

{string} A string representing the engine_version.

matchInstanceFromBacktestResultName(backtestResultName)

matchInstanceFromBacktestResultName(backtestResultName: string): string | number;

Parse the instance from BacktestResult resource.

Parameter
Name Description
backtestResultName string

A fully-qualified path representing BacktestResult resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromDatasetName(datasetName)

matchInstanceFromDatasetName(datasetName: string): string | number;

Parse the instance from Dataset resource.

Parameter
Name Description
datasetName string

A fully-qualified path representing Dataset resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromEngineConfigName(engineConfigName)

matchInstanceFromEngineConfigName(engineConfigName: string): string | number;

Parse the instance from EngineConfig resource.

Parameter
Name Description
engineConfigName string

A fully-qualified path representing EngineConfig resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromEngineVersionName(engineVersionName)

matchInstanceFromEngineVersionName(engineVersionName: string): string | number;

Parse the instance from EngineVersion resource.

Parameter
Name Description
engineVersionName string

A fully-qualified path representing EngineVersion resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromInstanceName(instanceName)

matchInstanceFromInstanceName(instanceName: string): string | number;

Parse the instance from Instance resource.

Parameter
Name Description
instanceName string

A fully-qualified path representing Instance resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromModelName(modelName)

matchInstanceFromModelName(modelName: string): string | number;

Parse the instance from Model resource.

Parameter
Name Description
modelName string

A fully-qualified path representing Model resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchInstanceFromPredictionResultName(predictionResultName)

matchInstanceFromPredictionResultName(predictionResultName: string): string | number;

Parse the instance from PredictionResult resource.

Parameter
Name Description
predictionResultName string

A fully-qualified path representing PredictionResult resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchLocationFromBacktestResultName(backtestResultName)

matchLocationFromBacktestResultName(backtestResultName: string): string | number;

Parse the location from BacktestResult resource.

Parameter
Name Description
backtestResultName string

A fully-qualified path representing BacktestResult resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromDatasetName(datasetName)

matchLocationFromDatasetName(datasetName: string): string | number;

Parse the location from Dataset resource.

Parameter
Name Description
datasetName string

A fully-qualified path representing Dataset resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromEngineConfigName(engineConfigName)

matchLocationFromEngineConfigName(engineConfigName: string): string | number;

Parse the location from EngineConfig resource.

Parameter
Name Description
engineConfigName string

A fully-qualified path representing EngineConfig resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromEngineVersionName(engineVersionName)

matchLocationFromEngineVersionName(engineVersionName: string): string | number;

Parse the location from EngineVersion resource.

Parameter
Name Description
engineVersionName string

A fully-qualified path representing EngineVersion resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromInstanceName(instanceName)

matchLocationFromInstanceName(instanceName: string): string | number;

Parse the location from Instance resource.

Parameter
Name Description
instanceName string

A fully-qualified path representing Instance resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromModelName(modelName)

matchLocationFromModelName(modelName: string): string | number;

Parse the location from Model resource.

Parameter
Name Description
modelName string

A fully-qualified path representing Model resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromPredictionResultName(predictionResultName)

matchLocationFromPredictionResultName(predictionResultName: string): string | number;

Parse the location from PredictionResult resource.

Parameter
Name Description
predictionResultName string

A fully-qualified path representing PredictionResult resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchModelFromModelName(modelName)

matchModelFromModelName(modelName: string): string | number;

Parse the model from Model resource.

Parameter
Name Description
modelName string

A fully-qualified path representing Model resource.
Returns
Type Description
string | number

{string} A string representing the model.

matchPredictionResultFromPredictionResultName(predictionResultName)

matchPredictionResultFromPredictionResultName(predictionResultName: string): string | number;

Parse the prediction_result from PredictionResult resource.

Parameter
Name Description
predictionResultName string

A fully-qualified path representing PredictionResult resource.
Returns
Type Description
string | number

{string} A string representing the prediction_result.

matchProjectFromInstanceName(instanceName)

matchProjectFromInstanceName(instanceName: string): string | number;

Parse the project from Instance resource.

Parameter
Name Description
instanceName string

A fully-qualified path representing Instance resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectNumFromBacktestResultName(backtestResultName)

matchProjectNumFromBacktestResultName(backtestResultName: string): string | number;

Parse the project_num from BacktestResult resource.

Parameter
Name Description
backtestResultName string

A fully-qualified path representing BacktestResult resource.
Returns
Type Description
string | number

{string} A string representing the project_num.

matchProjectNumFromDatasetName(datasetName)

matchProjectNumFromDatasetName(datasetName: string): string | number;

Parse the project_num from Dataset resource.

Parameter
Name Description
datasetName string

A fully-qualified path representing Dataset resource.
Returns
Type Description
string | number

{string} A string representing the project_num.

matchProjectNumFromEngineConfigName(engineConfigName)

matchProjectNumFromEngineConfigName(engineConfigName: string): string | number;

Parse the project_num from EngineConfig resource.

Parameter
Name Description
engineConfigName string

A fully-qualified path representing EngineConfig resource.
Returns
Type Description
string | number

{string} A string representing the project_num.

matchProjectNumFromEngineVersionName(engineVersionName)

matchProjectNumFromEngineVersionName(engineVersionName: string): string | number;

Parse the project_num from EngineVersion resource.

Parameter
Name Description
engineVersionName string

A fully-qualified path representing EngineVersion resource.
Returns
Type Description
string | number

{string} A string representing the project_num.

matchProjectNumFromModelName(modelName)

matchProjectNumFromModelName(modelName: string): string | number;

Parse the project_num from Model resource.

Parameter
Name Description
modelName string

A fully-qualified path representing Model resource.
Returns
Type Description
string | number

{string} A string representing the project_num.

matchProjectNumFromPredictionResultName(predictionResultName)

matchProjectNumFromPredictionResultName(predictionResultName: string): string | number;

Parse the project_num from PredictionResult resource.

Parameter
Name Description
predictionResultName string

A fully-qualified path representing PredictionResult resource.
Returns
Type Description
string | number

{string} A string representing the project_num.

modelPath(projectNum, location, instance, model)

modelPath(projectNum: string, location: string, instance: string, model: string): string;

Return a fully-qualified model resource name string.

Parameters
Name Description
projectNum string
location string
instance string
model string
Returns
Type Description
string

{string} Resource name string.

predictionResultPath(projectNum, location, instance, predictionResult)

predictionResultPath(projectNum: string, location: string, instance: string, predictionResult: string): string;

Return a fully-qualified predictionResult resource name string.

Parameters
Name Description
projectNum string
location string
instance string
predictionResult string
Returns
Type Description
string

{string} Resource name string.

updateBacktestResult(request, options)

updateBacktestResult(request?: protos.google.cloud.financialservices.v1.IUpdateBacktestResultRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of a single BacktestResult.

Parameters
Name Description
request IUpdateBacktestResultRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const updateMask = {}
  /**
   *  Required. The new value of the BacktestResult fields that will be updated
   *  according to the update_mask.
   */
  // const backtestResult = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callUpdateBacktestResult() {
    // Construct request
    const request = {
      backtestResult,
    };

    // Run request
    const [operation] = await financialservicesClient.updateBacktestResult(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateBacktestResult();

updateBacktestResult(request, options, callback)

updateBacktestResult(request: protos.google.cloud.financialservices.v1.IUpdateBacktestResultRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateBacktestResultRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateBacktestResult(request, callback)

updateBacktestResult(request: protos.google.cloud.financialservices.v1.IUpdateBacktestResultRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateBacktestResultRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IBacktestResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDataset(request, options)

updateDataset(request?: protos.google.cloud.financialservices.v1.IUpdateDatasetRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of a single Dataset.

Parameters
Name Description
request IUpdateDatasetRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const updateMask = {}
  /**
   *  Required. The new value of the dataset fields that will be updated
   *  according to the update_mask.
   */
  // const dataset = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callUpdateDataset() {
    // Construct request
    const request = {
      dataset,
    };

    // Run request
    const [operation] = await financialservicesClient.updateDataset(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateDataset();

updateDataset(request, options, callback)

updateDataset(request: protos.google.cloud.financialservices.v1.IUpdateDatasetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDatasetRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateDataset(request, callback)

updateDataset(request: protos.google.cloud.financialservices.v1.IUpdateDatasetRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateDatasetRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IDataset, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateEngineConfig(request, options)

updateEngineConfig(request?: protos.google.cloud.financialservices.v1.IUpdateEngineConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of a single EngineConfig.

Parameters
Name Description
request IUpdateEngineConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const updateMask = {}
  /**
   *  Required. The new value of the EngineConfig fields that will be updated
   *  according to the update_mask.
   */
  // const engineConfig = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callUpdateEngineConfig() {
    // Construct request
    const request = {
      engineConfig,
    };

    // Run request
    const [operation] = await financialservicesClient.updateEngineConfig(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateEngineConfig();

updateEngineConfig(request, options, callback)

updateEngineConfig(request: protos.google.cloud.financialservices.v1.IUpdateEngineConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateEngineConfigRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateEngineConfig(request, callback)

updateEngineConfig(request: protos.google.cloud.financialservices.v1.IUpdateEngineConfigRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateEngineConfigRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IEngineConfig, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInstance(request, options)

updateInstance(request?: protos.google.cloud.financialservices.v1.IUpdateInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of a single Instance.

Parameters
Name Description
request IUpdateInstanceRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const updateMask = {}
  /**
   *  Required. The new value of the instance fields that will be updated
   *  according to the update_mask
   */
  // const instance = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callUpdateInstance() {
    // Construct request
    const request = {
      instance,
    };

    // Run request
    const [operation] = await financialservicesClient.updateInstance(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateInstance();

updateInstance(request, options, callback)

updateInstance(request: protos.google.cloud.financialservices.v1.IUpdateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInstance(request, callback)

updateInstance(request: protos.google.cloud.financialservices.v1.IUpdateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateInstanceRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IInstance, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateModel(request, options)

updateModel(request?: protos.google.cloud.financialservices.v1.IUpdateModelRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of a single Model.

Parameters
Name Description
request IUpdateModelRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const updateMask = {}
  /**
   *  Required. The new value of the Model fields that will be updated according
   *  to the update_mask.
   */
  // const model = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callUpdateModel() {
    // Construct request
    const request = {
      model,
    };

    // Run request
    const [operation] = await financialservicesClient.updateModel(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateModel();

updateModel(request, options, callback)

updateModel(request: protos.google.cloud.financialservices.v1.IUpdateModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateModelRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateModel(request, callback)

updateModel(request: protos.google.cloud.financialservices.v1.IUpdateModelRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateModelRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IModel, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updatePredictionResult(request, options)

updatePredictionResult(request?: protos.google.cloud.financialservices.v1.IUpdatePredictionResultRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of a single PredictionResult.

Parameters
Name Description
request IUpdatePredictionResultRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const updateMask = {}
  /**
   *  Required. The new value of the PredictionResult fields that will be updated
   *  according to the update_mask.
   */
  // const predictionResult = {}
  /**
   *  Optional. An optional request ID to identify requests. Specify a unique
   *  request ID so that if you must retry your request, the server will know to
   *  ignore the request if it has already been completed. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  For example, consider a situation where you make an initial request and the
   *  request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Financialservices library
  const {AMLClient} = require('@google-cloud/financialservices').v1;

  // Instantiates a client
  const financialservicesClient = new AMLClient();

  async function callUpdatePredictionResult() {
    // Construct request
    const request = {
      predictionResult,
    };

    // Run request
    const [operation] = await financialservicesClient.updatePredictionResult(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdatePredictionResult();

updatePredictionResult(request, options, callback)

updatePredictionResult(request: protos.google.cloud.financialservices.v1.IUpdatePredictionResultRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdatePredictionResultRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updatePredictionResult(request, callback)

updatePredictionResult(request: protos.google.cloud.financialservices.v1.IUpdatePredictionResultRequest, callback: Callback<LROperation<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdatePredictionResultRequest
callback Callback<LROperation<protos.google.cloud.financialservices.v1.IPredictionResult, protos.google.cloud.financialservices.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void