Class AMLClient (0.1.0)

AMLClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.financialservices_v1.services.aml.transports.base.AMLTransport, typing.Callable[[...], google.cloud.financialservices_v1.services.aml.transports.base.AMLTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type	Description
str	The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type	Description
AMLTransport	The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type	Description
str	The universe domain used by the client instance.

Methods

AMLClient

AMLClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.financialservices_v1.services.aml.transports.base.AMLTransport, typing.Callable[[...], google.cloud.financialservices_v1.services.aml.transports.base.AMLTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the aml client.

Parameters
Name	Description
credentials	Optional[google.auth.credentials.Credentials] The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport	Optional[Union[str,AMLTransport,Callable[..., AMLTransport]]] The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the AMLTransport constructor. If set to None, a transport is chosen automatically.
client_options	Optional[Union[google.api_core.client_options.ClientOptions, dict]] Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info	google.api_core.gapic_v1.client_info.ClientInfo The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

Warning: ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

backtest_result_path

backtest_result_path(
    project_num: str, location: str, instance: str, backtest_result: str
) -> str

Returns a fully-qualified backtest_result string.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

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.

Parameters
Name	Description
request	.operations_pb2.CancelOperationRequest The request object. Request message for CancelOperation method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_backtest_result

create_backtest_result(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.backtest_result.CreateBacktestResultRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    backtest_result: typing.Optional[
        google.cloud.financialservices_v1.types.backtest_result.BacktestResult
    ] = None,
    backtest_result_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Create a BacktestResult.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_create_backtest_result():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    backtest_result = financialservices_v1.BacktestResult()
    backtest_result.dataset = "dataset_value"
    backtest_result.model = "model_value"
    backtest_result.performance_target.party_investigations_per_period_hint = 3872

    request = financialservices_v1.CreateBacktestResultRequest(
        parent="parent_value",
        backtest_result_id="backtest_result_id_value",
        backtest_result=backtest_result,
    )

    # Make the request
    operation = client.create_backtest_result(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.CreateBacktestResultRequest, dict] The request object. Request for creating a BacktestResult resource.
parent	str Required. The parent of the BacktestResult is the Instance. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
backtest_result	google.cloud.financialservices_v1.types.BacktestResult Required. The BacktestResult that will be created. This corresponds to the backtest_result field on the request instance; if request is provided, this should not be set.
backtest_result_id	str Required. The resource id of the BacktestResult This corresponds to the backtest_result_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be BacktestResult BacktestResult is created to test the performance of a model on a dataset.

create_dataset

create_dataset(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.dataset.CreateDatasetRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    dataset: typing.Optional[
        google.cloud.financialservices_v1.types.dataset.Dataset
    ] = None,
    dataset_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a dataset.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_create_dataset():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.CreateDatasetRequest(
        parent="parent_value",
        dataset_id="dataset_id_value",
    )

    # Make the request
    operation = client.create_dataset(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.CreateDatasetRequest, dict] The request object. Request for creating a Dataset resource.
parent	str Required. The parent of the Dataset is the Instance. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
dataset	google.cloud.financialservices_v1.types.Dataset Required. The dataset that will be created. This corresponds to the dataset field on the request instance; if request is provided, this should not be set.
dataset_id	str Required. The resource id of the dataset This corresponds to the dataset_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Dataset The Dataset resource contains summary information about a dataset.

create_engine_config

create_engine_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.engine_config.CreateEngineConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    engine_config: typing.Optional[
        google.cloud.financialservices_v1.types.engine_config.EngineConfig
    ] = None,
    engine_config_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates an engine config.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_create_engine_config():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    engine_config = financialservices_v1.EngineConfig()
    engine_config.engine_version = "engine_version_value"

    request = financialservices_v1.CreateEngineConfigRequest(
        parent="parent_value",
        engine_config_id="engine_config_id_value",
        engine_config=engine_config,
    )

    # Make the request
    operation = client.create_engine_config(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.CreateEngineConfigRequest, dict] The request object. Request for creating an EngineConfig resource.
parent	str Required. The parent of the EngineConfig is the Instance. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
engine_config	google.cloud.financialservices_v1.types.EngineConfig Required. The EngineConfig that will be created. This corresponds to the engine_config field on the request instance; if request is provided, this should not be set.
engine_config_id	str Required. The resource id of the EngineConfig This corresponds to the engine_config_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be EngineConfig The EngineConfig resource creates the configuration for training a model.

create_instance

create_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.instance.CreateInstanceRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    instance: typing.Optional[
        google.cloud.financialservices_v1.types.instance.Instance
    ] = None,
    instance_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates an instance.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_create_instance():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    instance = financialservices_v1.Instance()
    instance.kms_key = "kms_key_value"

    request = financialservices_v1.CreateInstanceRequest(
        parent="parent_value",
        instance_id="instance_id_value",
        instance=instance,
    )

    # Make the request
    operation = client.create_instance(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.CreateInstanceRequest, dict] The request object. Request for creating a Instance resource.
parent	str Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
instance	google.cloud.financialservices_v1.types.Instance Required. The instance that will be created. This corresponds to the instance field on the request instance; if request is provided, this should not be set.
instance_id	str Required. The resource id of the instance. This corresponds to the instance_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Instance Instance is a container for the rest of API resources. Only resources in the same instance can interact with each other. Child resources inherit the location (data residency) and encryption (CMEK). The location of the provided input and output in requests must match the location of the instance.

create_model

create_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.model.CreateModelRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    model: typing.Optional[google.cloud.financialservices_v1.types.model.Model] = None,
    model_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a model.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_create_model():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    model = financialservices_v1.Model()
    model.engine_config = "engine_config_value"
    model.primary_dataset = "primary_dataset_value"

    request = financialservices_v1.CreateModelRequest(
        parent="parent_value",
        model_id="model_id_value",
        model=model,
    )

    # Make the request
    operation = client.create_model(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.CreateModelRequest, dict] The request object. Request for creating a Model resource.
parent	str Required. The parent of the Model is the Instance. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
model	google.cloud.financialservices_v1.types.Model Required. The Model that will be created. This corresponds to the model field on the request instance; if request is provided, this should not be set.
model_id	str Required. The resource id of the Model This corresponds to the model_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Model Model represents a trained model.

create_prediction_result

create_prediction_result(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.prediction_result.CreatePredictionResultRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    prediction_result: typing.Optional[
        google.cloud.financialservices_v1.types.prediction_result.PredictionResult
    ] = None,
    prediction_result_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Create a PredictionResult.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_create_prediction_result():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    prediction_result = financialservices_v1.PredictionResult()
    prediction_result.dataset = "dataset_value"
    prediction_result.model = "model_value"
    prediction_result.outputs.prediction_destination.write_disposition = "WRITE_TRUNCATE"

    request = financialservices_v1.CreatePredictionResultRequest(
        parent="parent_value",
        prediction_result_id="prediction_result_id_value",
        prediction_result=prediction_result,
    )

    # Make the request
    operation = client.create_prediction_result(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.CreatePredictionResultRequest, dict] The request object. Request for creating a PredictionResult resource.
parent	str Required. The parent of the PredictionResult is the Instance. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
prediction_result	google.cloud.financialservices_v1.types.PredictionResult Required. The PredictionResult that will be created. This corresponds to the prediction_result field on the request instance; if request is provided, this should not be set.
prediction_result_id	str Required. The resource id of the PredictionResult This corresponds to the prediction_result_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be PredictionResult PredictionResult is the result of using a model to create predictions.

dataset_path

dataset_path(project_num: str, location: str, instance: str, dataset: str) -> str

Returns a fully-qualified dataset string.

delete_backtest_result

delete_backtest_result(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.backtest_result.DeleteBacktestResultRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a BacktestResult.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_delete_backtest_result():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.DeleteBacktestResultRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_backtest_result(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.DeleteBacktestResultRequest, dict] The request object. Request for deleting a BacktestResult.
name	str Required. The resource name of the BacktestResult. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_dataset

delete_dataset(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.dataset.DeleteDatasetRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a dataset.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_delete_dataset():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.DeleteDatasetRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_dataset(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.DeleteDatasetRequest, dict] The request object. Request for deleting a Dataset.
name	str Required. The resource name of the Dataset. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_engine_config

delete_engine_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.engine_config.DeleteEngineConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes an engine config.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_delete_engine_config():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.DeleteEngineConfigRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_engine_config(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.DeleteEngineConfigRequest, dict] The request object. Request for deleting an EngineConfig.
name	str Required. The resource name of the EngineConfig. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_instance

delete_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.instance.DeleteInstanceRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes an instance.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_delete_instance():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.DeleteInstanceRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_instance(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.DeleteInstanceRequest, dict] The request object. Request for deleting a Instance.
name	str Required. The resource name of the Instance. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_model

delete_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.model.DeleteModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a model.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_delete_model():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.DeleteModelRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_model(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.DeleteModelRequest, dict] The request object. Request for deleting a Model.
name	str Required. The resource name of the Model. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

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	.operations_pb2.DeleteOperationRequest The request object. Request message for DeleteOperation method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

delete_prediction_result

delete_prediction_result(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.prediction_result.DeletePredictionResultRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a PredictionResult.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_delete_prediction_result():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.DeletePredictionResultRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_prediction_result(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.DeletePredictionResultRequest, dict] The request object. Request for deleting a PredictionResult.
name	str Required. The resource name of the PredictionResult. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

engine_config_path

engine_config_path(
    project_num: str, location: str, instance: str, engine_config: str
) -> str

Returns a fully-qualified engine_config string.

engine_version_path

engine_version_path(
    project_num: str, location: str, instance: str, engine_version: str
) -> str

Returns a fully-qualified engine_version string.

export_backtest_result_metadata

export_backtest_result_metadata(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.backtest_result.ExportBacktestResultMetadataRequest,
            dict,
        ]
    ] = None,
    *,
    backtest_result: typing.Optional[str] = None,
    structured_metadata_destination: typing.Optional[
        google.cloud.financialservices_v1.types.bigquery_destination.BigQueryDestination
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

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>__.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_export_backtest_result_metadata():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    structured_metadata_destination = financialservices_v1.BigQueryDestination()
    structured_metadata_destination.write_disposition = "WRITE_TRUNCATE"

    request = financialservices_v1.ExportBacktestResultMetadataRequest(
        backtest_result="backtest_result_value",
        structured_metadata_destination=structured_metadata_destination,
    )

    # Make the request
    operation = client.export_backtest_result_metadata(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.ExportBacktestResultMetadataRequest, dict] The request object. Request for exporting BacktestResult metadata.
backtest_result	str Required. The resource name of the BacktestResult. This corresponds to the backtest_result field on the request instance; if request is provided, this should not be set.
structured_metadata_destination	google.cloud.financialservices_v1.types.BigQueryDestination Required. BigQuery output where the metadata will be written. This corresponds to the structured_metadata_destination field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be ExportBacktestResultMetadataResponse Response for exporting BacktestResult metadata.

export_engine_config_metadata

export_engine_config_metadata(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.engine_config.ExportEngineConfigMetadataRequest,
            dict,
        ]
    ] = None,
    *,
    engine_config: typing.Optional[str] = None,
    structured_metadata_destination: typing.Optional[
        google.cloud.financialservices_v1.types.bigquery_destination.BigQueryDestination
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

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>__.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_export_engine_config_metadata():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    structured_metadata_destination = financialservices_v1.BigQueryDestination()
    structured_metadata_destination.write_disposition = "WRITE_TRUNCATE"

    request = financialservices_v1.ExportEngineConfigMetadataRequest(
        engine_config="engine_config_value",
        structured_metadata_destination=structured_metadata_destination,
    )

    # Make the request
    operation = client.export_engine_config_metadata(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.ExportEngineConfigMetadataRequest, dict] The request object. Request for exporting EngineConfig metadata.
engine_config	str Required. The resource name of the EngineConfig. This corresponds to the engine_config field on the request instance; if request is provided, this should not be set.
structured_metadata_destination	google.cloud.financialservices_v1.types.BigQueryDestination Required. BigQuery output where the metadata will be written. This corresponds to the structured_metadata_destination field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be ExportEngineConfigMetadataResponse Response for exporting EngineConfig metadata.

export_model_metadata

export_model_metadata(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.model.ExportModelMetadataRequest,
            dict,
        ]
    ] = None,
    *,
    model: typing.Optional[str] = None,
    structured_metadata_destination: typing.Optional[
        google.cloud.financialservices_v1.types.bigquery_destination.BigQueryDestination
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

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>__.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_export_model_metadata():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    structured_metadata_destination = financialservices_v1.BigQueryDestination()
    structured_metadata_destination.write_disposition = "WRITE_TRUNCATE"

    request = financialservices_v1.ExportModelMetadataRequest(
        model="model_value",
        structured_metadata_destination=structured_metadata_destination,
    )

    # Make the request
    operation = client.export_model_metadata(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.ExportModelMetadataRequest, dict] The request object. Request for exporting Model metadata.
model	str Required. The resource name of the Model. This corresponds to the model field on the request instance; if request is provided, this should not be set.
structured_metadata_destination	google.cloud.financialservices_v1.types.BigQueryDestination Required. BigQuery output where the metadata will be written. This corresponds to the structured_metadata_destination field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be ExportModelMetadataResponse Response for exporting Model metadata.

export_prediction_result_metadata

export_prediction_result_metadata(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.prediction_result.ExportPredictionResultMetadataRequest,
            dict,
        ]
    ] = None,
    *,
    prediction_result: typing.Optional[str] = None,
    structured_metadata_destination: typing.Optional[
        google.cloud.financialservices_v1.types.bigquery_destination.BigQueryDestination
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

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>__.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_export_prediction_result_metadata():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    structured_metadata_destination = financialservices_v1.BigQueryDestination()
    structured_metadata_destination.write_disposition = "WRITE_TRUNCATE"

    request = financialservices_v1.ExportPredictionResultMetadataRequest(
        prediction_result="prediction_result_value",
        structured_metadata_destination=structured_metadata_destination,
    )

    # Make the request
    operation = client.export_prediction_result_metadata(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.ExportPredictionResultMetadataRequest, dict] The request object. Request for exporting PredictionResult metadata.
prediction_result	str Required. The resource name of the PredictionResult. This corresponds to the prediction_result field on the request instance; if request is provided, this should not be set.
structured_metadata_destination	google.cloud.financialservices_v1.types.BigQueryDestination Required. BigQuery output where the metadata will be written. This corresponds to the structured_metadata_destination field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be ExportPredictionResultMetadataResponse Response for exporting PredictionResult metadata.

export_registered_parties

export_registered_parties(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.instance.ExportRegisteredPartiesRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    dataset: typing.Optional[
        google.cloud.financialservices_v1.types.bigquery_destination.BigQueryDestination
    ] = None,
    line_of_business: typing.Optional[
        google.cloud.financialservices_v1.types.line_of_business.LineOfBusiness
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

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.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_export_registered_parties():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    dataset = financialservices_v1.BigQueryDestination()
    dataset.write_disposition = "WRITE_TRUNCATE"

    request = financialservices_v1.ExportRegisteredPartiesRequest(
        name="name_value",
        dataset=dataset,
        line_of_business="RETAIL",
    )

    # Make the request
    operation = client.export_registered_parties(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.ExportRegisteredPartiesRequest, dict] The request object. Request to export a list of currently registered parties.
name	str Required. The full path to the Instance resource in this API. format: "projects/{project}/locations/{location}/instances/{instance}" This corresponds to the name field on the request instance; if request is provided, this should not be set.
dataset	google.cloud.financialservices_v1.types.BigQueryDestination Required. The location to output the RegisteredParties. This corresponds to the dataset field on the request instance; if request is provided, this should not be set.
line_of_business	google.cloud.financialservices_v1.types.LineOfBusiness Required. LineOfBusiness to get RegisteredParties from. This corresponds to the line_of_business field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be ExportRegisteredPartiesResponse Response to export registered parties request.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
AMLClient	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name	Description
info	dict The service account private key info.

Returns
Type	Description
AMLClient	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
AMLClient	The constructed client.

get_backtest_result

get_backtest_result(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.backtest_result.GetBacktestResultRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.types.backtest_result.BacktestResult

Gets a BacktestResult.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_get_backtest_result():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.GetBacktestResultRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_backtest_result(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.GetBacktestResultRequest, dict] The request object. Request for retrieving a specific BacktestResult resource.
name	str Required. The resource name of the BacktestResult This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.types.BacktestResult	BacktestResult is created to test the performance of a model on a dataset.

get_dataset

get_dataset(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.dataset.GetDatasetRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.types.dataset.Dataset

Gets a dataset.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_get_dataset():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.GetDatasetRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_dataset(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.GetDatasetRequest, dict] The request object. Request for retrieving a specific Dataset resource.
name	str Required. The resource name of the Dataset This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.types.Dataset	The Dataset resource contains summary information about a dataset.

get_engine_config

get_engine_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.engine_config.GetEngineConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.types.engine_config.EngineConfig

Gets an engine config.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_get_engine_config():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.GetEngineConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_engine_config(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.GetEngineConfigRequest, dict] The request object. Request for retrieving a specific EngineConfig resource.
name	str Required. The resource name of the EngineConfig This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.types.EngineConfig	The EngineConfig resource creates the configuration for training a model.

get_engine_version

get_engine_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.engine_version.GetEngineVersionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.types.engine_version.EngineVersion

Gets a single EngineVersion.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_get_engine_version():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.GetEngineVersionRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_engine_version(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.GetEngineVersionRequest, dict] The request object. Request for retrieving a specific EngineVersion resource.
name	str Required. The resource name of the EngineVersion This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.types.EngineVersion	EngineVersion controls which version of the engine is used to tune, train, and run the model.

get_instance

get_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.instance.GetInstanceRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.types.instance.Instance

Gets an instance.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_get_instance():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.GetInstanceRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_instance(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.GetInstanceRequest, dict] The request object. Request for retrieving a specific Instance resource.
name	str Required. The resource name of the Instance. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.types.Instance	Instance is a container for the rest of API resources. Only resources in the same instance can interact with each other. Child resources inherit the location (data residency) and encryption (CMEK). The location of the provided input and output in requests must match the location of the instance.

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name	Description
request	.location_pb2.GetLocationRequest The request object. Request message for GetLocation method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.location_pb2.Location	Location object.

get_model

get_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.model.GetModelRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.types.model.Model

Gets a model.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_get_model():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.GetModelRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_model(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.GetModelRequest, dict] The request object. Request for retrieving a specific Model resource.
name	str Required. The resource name of the Model This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.types.Model	Model represents a trained model.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
client_options	google.api_core.client_options.ClientOptions Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns
Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name	Description
request	.operations_pb2.GetOperationRequest The request object. Request message for GetOperation method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.operations_pb2.Operation	An Operation object.

get_prediction_result

get_prediction_result(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.prediction_result.GetPredictionResultRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.types.prediction_result.PredictionResult

Gets a PredictionResult.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_get_prediction_result():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.GetPredictionResultRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_prediction_result(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.GetPredictionResultRequest, dict] The request object. Request for retrieving a specific PredictionResult resource.
name	str Required. The resource name of the PredictionResult This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.types.PredictionResult	PredictionResult is the result of using a model to create predictions.

import_registered_parties

import_registered_parties(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.instance.ImportRegisteredPartiesRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    mode: typing.Optional[
        google.cloud.financialservices_v1.types.instance.ImportRegisteredPartiesRequest.UpdateMode
    ] = None,
    line_of_business: typing.Optional[
        google.cloud.financialservices_v1.types.line_of_business.LineOfBusiness
    ] = None,
    party_tables: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

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.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_import_registered_parties():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.ImportRegisteredPartiesRequest(
        name="name_value",
        mode="APPEND",
        line_of_business="RETAIL",
    )

    # Make the request
    operation = client.import_registered_parties(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.ImportRegisteredPartiesRequest, dict] The request object. Request for adding/removing registered parties from BigQuery tables specified by the customer.
name	str Required. The full path to the Instance resource in this API. format: "projects/{project}/locations/{location}/instances/{instance}" This corresponds to the name field on the request instance; if request is provided, this should not be set.
mode	google.cloud.financialservices_v1.types.ImportRegisteredPartiesRequest.UpdateMode Required. Mode of the request. This corresponds to the mode field on the request instance; if request is provided, this should not be set.
line_of_business	google.cloud.financialservices_v1.types.LineOfBusiness Required. LineOfBusiness for the specified registered parties. This corresponds to the line_of_business field on the request instance; if request is provided, this should not be set.
party_tables	MutableSequence[str] 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 This corresponds to the party_tables field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be ImportRegisteredPartiesResponse Response for adding/removing registered parties from BigQuery tables.

instance_path

instance_path(project: str, location: str, instance: str) -> str

Returns a fully-qualified instance string.

list_backtest_results

list_backtest_results(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.backtest_result.ListBacktestResultsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.services.aml.pagers.ListBacktestResultsPager

List BacktestResults.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_list_backtest_results():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.ListBacktestResultsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_backtest_results(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.ListBacktestResultsRequest, dict] The request object. Request for retrieving a paginated list of BacktestResult resources that meet the specified criteria.
parent	str Required. The parent of the BacktestResult is the Instance. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.services.aml.pagers.ListBacktestResultsPager	Response for retrieving a list of BacktestResults Iterating over this object will yield results and resolve additional pages automatically.

list_datasets

list_datasets(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.dataset.ListDatasetsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.services.aml.pagers.ListDatasetsPager

Lists datasets.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_list_datasets():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.ListDatasetsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_datasets(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.ListDatasetsRequest, dict] The request object. Request for retrieving a paginated list of Dataset resources that meet the specified criteria.
parent	str Required. The parent of the Dataset is the Instance. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.services.aml.pagers.ListDatasetsPager	Response for retrieving a list of Datasets Iterating over this object will yield results and resolve additional pages automatically.

list_engine_configs

list_engine_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.engine_config.ListEngineConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.services.aml.pagers.ListEngineConfigsPager

Lists engine configs.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_list_engine_configs():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.ListEngineConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_engine_configs(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.ListEngineConfigsRequest, dict] The request object. Request for retrieving a paginated list of EngineConfig resources that meet the specified criteria.
parent	str Required. The parent of the EngineConfig is the Instance. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.services.aml.pagers.ListEngineConfigsPager	Response for retrieving a list of EngineConfigs Iterating over this object will yield results and resolve additional pages automatically.

list_engine_versions

list_engine_versions(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.engine_version.ListEngineVersionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.services.aml.pagers.ListEngineVersionsPager

Lists EngineVersions for given location.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_list_engine_versions():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.ListEngineVersionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_engine_versions(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.ListEngineVersionsRequest, dict] The request object. Request for retrieving a paginated list of EngineVersion resources that meet the specified criteria.
parent	str Required. The parent of the EngineVersion is the Instance. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.services.aml.pagers.ListEngineVersionsPager	The response to a list call containing the list of engine versions. Iterating over this object will yield results and resolve additional pages automatically.

list_instances

list_instances(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.instance.ListInstancesRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.services.aml.pagers.ListInstancesPager

Lists instances.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_list_instances():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.ListInstancesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_instances(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.ListInstancesRequest, dict] The request object. Request for retrieving a paginated list of Instance resources that meet the specified criteria.
parent	str Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.services.aml.pagers.ListInstancesPager	Response for retrieving a list of Instances Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name	Description
request	.location_pb2.ListLocationsRequest The request object. Request message for ListLocations method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.location_pb2.ListLocationsResponse	Response message for ListLocations method.

list_models

list_models(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.model.ListModelsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.services.aml.pagers.ListModelsPager

Lists models.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_list_models():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.ListModelsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_models(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.ListModelsRequest, dict] The request object. Request for retrieving a paginated list of Model resources that meet the specified criteria.
parent	str Required. The parent of the Model is the Instance. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.services.aml.pagers.ListModelsPager	Response for retrieving a list of Models Iterating over this object will yield results and resolve additional pages automatically.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name	Description
request	.operations_pb2.ListOperationsRequest The request object. Request message for ListOperations method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.operations_pb2.ListOperationsResponse	Response message for ListOperations method.

list_prediction_results

list_prediction_results(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.prediction_result.ListPredictionResultsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.financialservices_v1.services.aml.pagers.ListPredictionResultsPager

List PredictionResults.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_list_prediction_results():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.ListPredictionResultsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_prediction_results(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.ListPredictionResultsRequest, dict] The request object. Request for retrieving a paginated list of PredictionResult resources that meet the specified criteria.
parent	str Required. The parent of the PredictionResult is the Instance. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.financialservices_v1.services.aml.pagers.ListPredictionResultsPager	Response for retrieving a list of PredictionResults Iterating over this object will yield results and resolve additional pages automatically.

model_path

model_path(project_num: str, location: str, instance: str, model: str) -> str

Returns a fully-qualified model string.

parse_backtest_result_path

parse_backtest_result_path(path: str) -> typing.Dict[str, str]

Parses a backtest_result path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_dataset_path

parse_dataset_path(path: str) -> typing.Dict[str, str]

Parses a dataset path into its component segments.

parse_engine_config_path

parse_engine_config_path(path: str) -> typing.Dict[str, str]

Parses a engine_config path into its component segments.

parse_engine_version_path

parse_engine_version_path(path: str) -> typing.Dict[str, str]

Parses a engine_version path into its component segments.

parse_instance_path

parse_instance_path(path: str) -> typing.Dict[str, str]

Parses a instance path into its component segments.

parse_model_path

parse_model_path(path: str) -> typing.Dict[str, str]

Parses a model path into its component segments.

parse_prediction_result_path

parse_prediction_result_path(path: str) -> typing.Dict[str, str]

Parses a prediction_result path into its component segments.

prediction_result_path

prediction_result_path(
    project_num: str, location: str, instance: str, prediction_result: str
) -> str

Returns a fully-qualified prediction_result string.

update_backtest_result

update_backtest_result(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.backtest_result.UpdateBacktestResultRequest,
            dict,
        ]
    ] = None,
    *,
    backtest_result: typing.Optional[
        google.cloud.financialservices_v1.types.backtest_result.BacktestResult
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates the parameters of a single BacktestResult.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_update_backtest_result():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    backtest_result = financialservices_v1.BacktestResult()
    backtest_result.dataset = "dataset_value"
    backtest_result.model = "model_value"
    backtest_result.performance_target.party_investigations_per_period_hint = 3872

    request = financialservices_v1.UpdateBacktestResultRequest(
        backtest_result=backtest_result,
    )

    # Make the request
    operation = client.update_backtest_result(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.UpdateBacktestResultRequest, dict] The request object. Request for updating a BacktestResult
backtest_result	google.cloud.financialservices_v1.types.BacktestResult Required. The new value of the BacktestResult fields that will be updated according to the update_mask. This corresponds to the backtest_result field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask 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. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be BacktestResult BacktestResult is created to test the performance of a model on a dataset.

update_dataset

update_dataset(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.dataset.UpdateDatasetRequest, dict
        ]
    ] = None,
    *,
    dataset: typing.Optional[
        google.cloud.financialservices_v1.types.dataset.Dataset
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates the parameters of a single Dataset.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_update_dataset():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    request = financialservices_v1.UpdateDatasetRequest(
    )

    # Make the request
    operation = client.update_dataset(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.UpdateDatasetRequest, dict] The request object. Request for updating a Dataset
dataset	google.cloud.financialservices_v1.types.Dataset Required. The new value of the dataset fields that will be updated according to the update_mask. This corresponds to the dataset field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask 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. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Dataset The Dataset resource contains summary information about a dataset.

update_engine_config

update_engine_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.engine_config.UpdateEngineConfigRequest,
            dict,
        ]
    ] = None,
    *,
    engine_config: typing.Optional[
        google.cloud.financialservices_v1.types.engine_config.EngineConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates the parameters of a single EngineConfig.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_update_engine_config():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    engine_config = financialservices_v1.EngineConfig()
    engine_config.engine_version = "engine_version_value"

    request = financialservices_v1.UpdateEngineConfigRequest(
        engine_config=engine_config,
    )

    # Make the request
    operation = client.update_engine_config(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.UpdateEngineConfigRequest, dict] The request object. Request for updating an EngineConfig
engine_config	google.cloud.financialservices_v1.types.EngineConfig Required. The new value of the EngineConfig fields that will be updated according to the update_mask. This corresponds to the engine_config field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask 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. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be EngineConfig The EngineConfig resource creates the configuration for training a model.

update_instance

update_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.instance.UpdateInstanceRequest, dict
        ]
    ] = None,
    *,
    instance: typing.Optional[
        google.cloud.financialservices_v1.types.instance.Instance
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates the parameters of a single Instance.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_update_instance():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    instance = financialservices_v1.Instance()
    instance.kms_key = "kms_key_value"

    request = financialservices_v1.UpdateInstanceRequest(
        instance=instance,
    )

    # Make the request
    operation = client.update_instance(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.UpdateInstanceRequest, dict] The request object. Request for updating a Instance
instance	google.cloud.financialservices_v1.types.Instance Required. The new value of the instance fields that will be updated according to the update_mask This corresponds to the instance field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask 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. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Instance Instance is a container for the rest of API resources. Only resources in the same instance can interact with each other. Child resources inherit the location (data residency) and encryption (CMEK). The location of the provided input and output in requests must match the location of the instance.

update_model

update_model(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.model.UpdateModelRequest, dict
        ]
    ] = None,
    *,
    model: typing.Optional[google.cloud.financialservices_v1.types.model.Model] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates the parameters of a single Model.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_update_model():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    model = financialservices_v1.Model()
    model.engine_config = "engine_config_value"
    model.primary_dataset = "primary_dataset_value"

    request = financialservices_v1.UpdateModelRequest(
        model=model,
    )

    # Make the request
    operation = client.update_model(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.UpdateModelRequest, dict] The request object. Request for updating a Model
model	google.cloud.financialservices_v1.types.Model Required. The new value of the Model fields that will be updated according to the update_mask. This corresponds to the model field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask 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. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Model Model represents a trained model.

update_prediction_result

update_prediction_result(
    request: typing.Optional[
        typing.Union[
            google.cloud.financialservices_v1.types.prediction_result.UpdatePredictionResultRequest,
            dict,
        ]
    ] = None,
    *,
    prediction_result: typing.Optional[
        google.cloud.financialservices_v1.types.prediction_result.PredictionResult
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates the parameters of a single PredictionResult.

# 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.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import financialservices_v1

def sample_update_prediction_result():
    # Create a client
    client = financialservices_v1.AMLClient()

    # Initialize request argument(s)
    prediction_result = financialservices_v1.PredictionResult()
    prediction_result.dataset = "dataset_value"
    prediction_result.model = "model_value"
    prediction_result.outputs.prediction_destination.write_disposition = "WRITE_TRUNCATE"

    request = financialservices_v1.UpdatePredictionResultRequest(
        prediction_result=prediction_result,
    )

    # Make the request
    operation = client.update_prediction_result(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.financialservices_v1.types.UpdatePredictionResultRequest, dict] The request object. Request for updating a PredictionResult
prediction_result	google.cloud.financialservices_v1.types.PredictionResult Required. The new value of the PredictionResult fields that will be updated according to the update_mask. This corresponds to the prediction_result field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask 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. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be PredictionResult PredictionResult is the result of using a model to create predictions.