{ "schemas": { "GoogleCloudFinancialservicesV1BacktestResultPerformanceTarget": { "type": "object", "id": "GoogleCloudFinancialservicesV1BacktestResultPerformanceTarget", "properties": { "partyInvestigationsPerPeriodHint": { "description": "Optional. A number that gives the tuner a hint on the number of parties from this data that will be investigated per period (monthly). This is used to control how the model is evaluated. For example, when trying AML AI for the first time, we recommend setting this to the number of parties investigated in an average month, based on alerts from your existing automated alerting system.", "type": "string", "format": "int64" } }, "description": "PerformanceTarget gives hints on how to evaluate the performance of a model." }, "GoogleCloudFinancialservicesV1ListDatasetsResponse": { "properties": { "datasets": { "description": "List of Dataset resources", "type": "array", "items": { "$ref": "GoogleCloudFinancialservicesV1Dataset" } }, "nextPageToken": { "description": "This token should be passed to the next ListDatasetsRequest to retrieve the next page of Datasets (empty indicates we are done).", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } }, "description": "Response for retrieving a list of Datasets", "type": "object", "id": "GoogleCloudFinancialservicesV1ListDatasetsResponse" }, "GoogleCloudFinancialservicesV1Model": { "properties": { "updateTime": { "description": "Output only. The timestamp of the most recent update of this resource.", "readOnly": true, "type": "string", "format": "google-datetime" }, "state": { "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING" ], "description": "Output only. State of the model (creating, active, deleting, etc.)", "type": "string", "enumDescriptions": [ "State is unspecified, should not occur.", "The resource has not finished being created.", "The resource is active/ready to be used.", "The resource is in the process of being updated.", "The resource is in the process of being deleted." ] }, "lineOfBusiness": { "readOnly": true, "description": "Output only. The line of business (Retail/Commercial) this model is used for. Determined by EngineConfig, cannot be set by user.", "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ], "type": "string", "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ] }, "satisfiesPzs": { "description": "Output only. [Output Only] Reserved for future use.", "readOnly": true, "type": "boolean" }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. [Output Only] Reserved for future use." }, "engineConfig": { "type": "string", "description": "Required. The resource name of the EngineConfig the model training will be based on. Format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}`" }, "name": { "description": "Output only. The resource name of the Model. format: `/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}`", "readOnly": true, "type": "string" }, "sourceModel": { "description": "Output only. The resource name of the source Model in case this model is a copy. Format: `projects/{project_num}/locations/{location}/instances/{instance}/models/{model}`", "readOnly": true, "type": "string" }, "labels": { "type": "object", "description": "Labels", "additionalProperties": { "type": "string" } }, "engineVersion": { "description": "Output only. The EngineVersion used in training this model. This is output only, and is determined from the EngineConfig used.", "readOnly": true, "type": "string" }, "primaryDataset": { "type": "string", "description": "Required. The resource name of the Primary Dataset used in this model training. For information about how primary and auxiliary datasets are used, refer to the engine version's documentation. Format: `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`" }, "createTime": { "description": "Output only. The timestamp of creation of this resource.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Required. End_time specifies the latest time from which labels are used and from which data is used to generate features for training. End_time should be no later than the end of the date_range of the dataset.", "type": "string", "format": "google-datetime" } }, "description": "Model represents a trained model.", "type": "object", "id": "GoogleCloudFinancialservicesV1Model" }, "GoogleCloudFinancialservicesV1PredictionResult": { "description": "PredictionResult is the result of using a model to create predictions.", "properties": { "dataset": { "description": "Required. The resource name of the Dataset to do predictions on Format: `/projects/{project_num}/locations/{location}/instances/{instance}/dataset/{dataset_id}`", "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The timestamp of the most recent update of this resource." }, "state": { "description": "Output only. State of the PredictionResult (creating, active, deleting, etc.)", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING" ], "type": "string", "enumDescriptions": [ "State is unspecified, should not occur.", "The resource has not finished being created.", "The resource is active/ready to be used.", "The resource is in the process of being updated.", "The resource is in the process of being deleted." ], "readOnly": true }, "outputs": { "description": "Required. Where to write the output of the predictions.", "$ref": "GoogleCloudFinancialservicesV1PredictionResultOutputs" }, "model": { "type": "string", "description": "Required. The resource name of the Model to use to use to make predictions Format: `/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}`" }, "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. [Output Only] Reserved for future use." }, "predictionPeriods": { "type": "integer", "format": "int32", "description": "The number of consecutive months to produce predictions for, ending with the last full month prior to end_time according to the dataset's timezone." }, "lineOfBusiness": { "type": "string", "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ], "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ], "description": "Output only. The line of business (Retail/Commercial) this prediction is for. Determined by Model, cannot be set by user.", "readOnly": true }, "labels": { "type": "object", "description": "Labels", "additionalProperties": { "type": "string" } }, "name": { "readOnly": true, "type": "string", "description": "Output only. The resource name of the PredictionResult. format: `/projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}`" }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. [Output Only] Reserved for future use." }, "endTime": { "type": "string", "format": "google-datetime", "description": "Required. Specifies the latest time from which data is used to generate features for predictions. This time should be no later than the end of the date_range of the dataset." }, "createTime": { "description": "Output only. The timestamp of creation of this resource.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudFinancialservicesV1PredictionResult", "type": "object" }, "Interval": { "id": "Interval", "type": "object", "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", "properties": { "startTime": { "type": "string", "format": "google-datetime", "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start." }, "endTime": { "type": "string", "format": "google-datetime", "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end." } } }, "GoogleCloudFinancialservicesV1ListBacktestResultsResponse": { "properties": { "backtestResults": { "description": "List of BacktestResult resources", "type": "array", "items": { "$ref": "GoogleCloudFinancialservicesV1BacktestResult" } }, "nextPageToken": { "type": "string", "description": "This token should be passed to the next ListBacktestResultsRequest to retrieve the next page of BacktestResults (empty indicates we are done)." }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } }, "description": "Response for retrieving a list of BacktestResults", "type": "object", "id": "GoogleCloudFinancialservicesV1ListBacktestResultsResponse" }, "GoogleCloudFinancialservicesV1EngineConfigTuning": { "description": "The parameters needed for the tuning operation, these are used only in tuning and not passed on to training.", "properties": { "primaryDataset": { "description": "Required. The resource name of the Primary Dataset used in this model tuning. For information about how primary and auxiliary datasets are used, refer to the engine version's documentation. Format: `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`", "type": "string" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Required. End_time specifies the latest time from which labels are used and from which data is used to generate features for tuning. End_time should be no later than the end of the date_range of the dataset." } }, "id": "GoogleCloudFinancialservicesV1EngineConfigTuning", "type": "object" }, "GoogleCloudFinancialservicesV1EngineVersion": { "description": "EngineVersion controls which version of the engine is used to tune, train, and run the model.", "properties": { "lineOfBusiness": { "readOnly": true, "type": "string", "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ], "description": "Output only. The line of business (Retail/Commercial) this engine version is used for.", "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ] }, "name": { "description": "Output only. Identifier. The resource name of the EngineVersion format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`", "readOnly": true, "type": "string" }, "expectedLimitationStartTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Planned time to stop allowing training/tuning using this version. Existing trained models can still be used for prediction/backtest." }, "expectedDecommissionTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Planned time to stop supporting the version, in addition to no training or tuning, models trained on this version can no longer be used for prediction/backtest." }, "state": { "type": "string", "enumDescriptions": [ "Default state, should never be used.", "Version is available for training and inference.", "Models using this version can still be run, but new ones cannot be trained.", "Version is deprecated, listed for informational purposes only." ], "description": "Output only. The state of the version.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "LIMITED", "DECOMMISSIONED" ], "readOnly": true } }, "id": "GoogleCloudFinancialservicesV1EngineVersion", "type": "object" }, "GoogleCloudFinancialservicesV1ListEngineConfigsResponse": { "type": "object", "id": "GoogleCloudFinancialservicesV1ListEngineConfigsResponse", "properties": { "engineConfigs": { "type": "array", "items": { "$ref": "GoogleCloudFinancialservicesV1EngineConfig" }, "description": "List of EngineConfig resources" }, "nextPageToken": { "description": "This token should be passed to the next ListEngineConfigsRequest to retrieve the next page of EngineConfigs (empty indicates we are done).", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } }, "description": "Response for retrieving a list of EngineConfigs" }, "GoogleCloudFinancialservicesV1ExportBacktestResultMetadataRequest": { "id": "GoogleCloudFinancialservicesV1ExportBacktestResultMetadataRequest", "type": "object", "description": "Request for exporting BacktestResult metadata.", "properties": { "structuredMetadataDestination": { "description": "Required. BigQuery output where the metadata will be written.", "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination" } } }, "GoogleCloudFinancialservicesV1Dataset": { "id": "GoogleCloudFinancialservicesV1Dataset", "type": "object", "description": "The Dataset resource contains summary information about a dataset.", "properties": { "timeZone": { "description": "Optional. The timezone of the data, default will act as UTC.", "$ref": "TimeZone" }, "name": { "readOnly": true, "type": "string", "description": "Output only. Identifier. The resource name of the Dataset. format: `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The timestamp of the most recent update of this resource." }, "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING" ], "description": "Output only. State of the dataset (creating, active, deleting, etc.)", "type": "string", "enumDescriptions": [ "State is unspecified, should not occur.", "The resource has not finished being created.", "The resource is active/ready to be used.", "The resource is in the process of being updated.", "The resource is in the process of being deleted." ], "readOnly": true }, "dateRange": { "description": "Required. Core time window of the dataset. All tables should have complete data covering this period.", "$ref": "Interval" }, "createTime": { "description": "Output only. The timestamp of creation of this resource.", "readOnly": true, "type": "string", "format": "google-datetime" }, "labels": { "type": "object", "description": "Optional. Labels", "additionalProperties": { "type": "string" } }, "tableSpecs": { "type": "object", "description": "Required. The set of BigQuery tables in the dataset. The key should be the table type and the value should be the BigQuery tables in the format `bq://{project}.{dataset}.{table}`. Current table types are: * `party` * `account_party_link` * `transaction` * `risk_case_event` * `party_supplementary_data`", "additionalProperties": { "type": "string" } } } }, "GoogleCloudFinancialservicesV1ListEngineVersionsResponse": { "properties": { "engineVersions": { "description": "List of EngineVersion resources", "type": "array", "items": { "$ref": "GoogleCloudFinancialservicesV1EngineVersion" } }, "nextPageToken": { "description": "This token should be passed to the next EngineVersionsRequest to retrieve the next page of EngineVersions (empty indicates we are done).", "type": "string" }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } }, "description": "The response to a list call containing the list of engine versions.", "type": "object", "id": "GoogleCloudFinancialservicesV1ListEngineVersionsResponse" }, "ListLocationsResponse": { "id": "ListLocationsResponse", "type": "object", "description": "The response message for Locations.ListLocations.", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "GoogleCloudFinancialservicesV1ExportEngineConfigMetadataRequest": { "description": "Request for exporting EngineConfig metadata.", "properties": { "structuredMetadataDestination": { "description": "Required. BigQuery output where the metadata will be written.", "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination" } }, "id": "GoogleCloudFinancialservicesV1ExportEngineConfigMetadataRequest", "type": "object" }, "GoogleCloudFinancialservicesV1ExportModelMetadataRequest": { "type": "object", "id": "GoogleCloudFinancialservicesV1ExportModelMetadataRequest", "properties": { "structuredMetadataDestination": { "description": "Required. BigQuery output where the metadata will be written.", "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination" } }, "description": "Request for exporting Model metadata." }, "GoogleCloudFinancialservicesV1ListPredictionResultsResponse": { "description": "Response for retrieving a list of PredictionResults", "properties": { "predictionResults": { "description": "List of PredictionResult resources", "type": "array", "items": { "$ref": "GoogleCloudFinancialservicesV1PredictionResult" } }, "nextPageToken": { "type": "string", "description": "This token should be passed to the next ListPredictionResultsRequest to retrieve the next page of PredictionResults (empty indicicates we are done)." }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } }, "id": "GoogleCloudFinancialservicesV1ListPredictionResultsResponse", "type": "object" }, "GoogleCloudFinancialservicesV1BacktestResult": { "type": "object", "id": "GoogleCloudFinancialservicesV1BacktestResult", "properties": { "name": { "readOnly": true, "type": "string", "description": "Output only. The resource name of the BacktestResult. format: `/projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}`" }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. [Output Only] Reserved for future use." }, "labels": { "description": "Labels", "additionalProperties": { "type": "string" }, "type": "object" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Required. End_time specifies the latest time from which labels are used and from which data is used to generate features for backtesting. End_time should be no later than the end of the date_range of the primary dataset." }, "createTime": { "description": "Output only. The timestamp of creation of this resource.", "readOnly": true, "type": "string", "format": "google-datetime" }, "backtestPeriods": { "description": "The number of consecutive months to conduct backtesting for, ending with the last full month prior to the end_time according to the dataset's timezone.", "type": "integer", "format": "int32" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The timestamp of the most recent update of this resource." }, "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING" ], "description": "Output only. State of the BacktestResult (creating, active, deleting, etc.)", "type": "string", "enumDescriptions": [ "State is unspecified, should not occur.", "The resource has not finished being created.", "The resource is active/ready to be used.", "The resource is in the process of being updated.", "The resource is in the process of being deleted." ], "readOnly": true }, "performanceTarget": { "description": "Required. PerformanceTarget gives information on how the test will be evaluated.", "$ref": "GoogleCloudFinancialservicesV1BacktestResultPerformanceTarget" }, "dataset": { "description": "Required. The resource name of the Dataset to backtest on Format: `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`", "type": "string" }, "lineOfBusiness": { "description": "Output only. The line of business (Retail/Commercial) this backtest is for. Determined by Model, cannot be set by user.", "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ], "type": "string", "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ], "readOnly": true }, "model": { "type": "string", "description": "Required. The resource name of the Model to use or to backtest. Format: `/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}`" }, "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. [Output Only] Reserved for future use." } }, "description": "BacktestResult is created to test the performance of a model on a dataset." }, "GoogleCloudFinancialservicesV1EngineConfig": { "type": "object", "id": "GoogleCloudFinancialservicesV1EngineConfig", "properties": { "createTime": { "description": "Output only. The timestamp of creation of this resource.", "readOnly": true, "type": "string", "format": "google-datetime" }, "hyperparameterSource": { "description": "Optional. Configuration of hyperparameters source EngineConfig.", "$ref": "GoogleCloudFinancialservicesV1EngineConfigHyperparameterSource" }, "labels": { "description": "Labels", "additionalProperties": { "type": "string" }, "type": "object" }, "engineVersion": { "description": "Required. The resource name of the EngineVersion used in this model tuning. format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`", "type": "string" }, "hyperparameterSourceType": { "type": "string", "enumDescriptions": [ "Hyperparameter source type is unspecified, defaults to TUNING.", "The EngineConfig creation starts a tuning job which selects the best hyperparameters.", "The hyperparameters are inherited from another EngineConfig." ], "description": "Optional. The origin of hyperparameters for the created EngineConfig. The default is `TUNING`. In this case, the hyperparameters are selected as a result of a tuning run.", "enum": [ "HYPERPARAMETER_SOURCE_TYPE_UNSPECIFIED", "TUNING", "INHERITED" ] }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. [Output Only] Reserved for future use." }, "name": { "description": "Output only. The resource name of the EngineConfig. format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`", "readOnly": true, "type": "string" }, "tuning": { "description": "Optional. Configuration for tuning in creation of the EngineConfig. This field is required if `hyperparameter_source.type` is not `INHERITED`, and output-only otherwise.", "$ref": "GoogleCloudFinancialservicesV1EngineConfigTuning" }, "satisfiesPzs": { "description": "Output only. [Output Only] Reserved for future use.", "readOnly": true, "type": "boolean" }, "lineOfBusiness": { "type": "string", "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ], "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ], "description": "Output only. The line of business (Retail/Commercial) this engine config is used for. Determined by EngineVersion, cannot be set by user.", "readOnly": true }, "performanceTarget": { "description": "Optional. PerformanceTarget gives information on how the tuning and training will be evaluated. This field is required if `hyperparameter_source.type` is not `INHERITED`, and output-only otherwise.", "$ref": "GoogleCloudFinancialservicesV1EngineConfigPerformanceTarget" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The timestamp of the most recent update of this resource." }, "state": { "readOnly": true, "type": "string", "enumDescriptions": [ "State is unspecified, should not occur.", "The resource has not finished being created.", "The resource is active/ready to be used.", "The resource is in the process of being updated.", "The resource is in the process of being deleted." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING" ], "description": "Output only. State of the EngineConfig (creating, active, deleting, etc.)" } }, "description": "The EngineConfig resource creates the configuration for training a model." }, "GoogleCloudFinancialservicesV1OperationMetadata": { "type": "object", "id": "GoogleCloudFinancialservicesV1OperationMetadata", "properties": { "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "target": { "readOnly": true, "type": "string", "description": "Output only. Server-defined resource path for the target of the operation. format: \"/projects/{project}/...\" VPC-SC restrictions apply." }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Successfully cancelled operations have a Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" } }, "description": "Represents the metadata of the long-running operation." }, "GoogleCloudFinancialservicesV1ImportRegisteredPartiesResponse": { "type": "object", "id": "GoogleCloudFinancialservicesV1ImportRegisteredPartiesResponse", "properties": { "partiesFailedToDowntier": { "description": "Number of parties that failed to be downtiered", "type": "string", "format": "int64" }, "partiesTotal": { "description": "Total number of parties that are registered in this instance, after the update operation was completed.", "type": "string", "format": "int64" }, "partiesDowntiered": { "type": "string", "format": "int64", "description": "Total number of parties that are downtiered in this instance" }, "partiesAdded": { "type": "string", "format": "int64", "description": "Number of parties added by this operation." }, "partiesRemoved": { "type": "string", "format": "int64", "description": "Number of parties removed by this operation." }, "partiesFailedToRemove": { "type": "string", "format": "int64", "description": "Number of parties that failed to be removed by this operation." }, "partiesUptiered": { "type": "string", "format": "int64" } }, "description": "Response for adding/removing registered parties from BigQuery tables." }, "GoogleCloudFinancialservicesV1ExportPredictionResultMetadataRequest": { "description": "Request for exporting PredictionResult metadata.", "properties": { "structuredMetadataDestination": { "description": "Required. BigQuery output where the metadata will be written.", "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination" } }, "id": "GoogleCloudFinancialservicesV1ExportPredictionResultMetadataRequest", "type": "object" }, "TimeZone": { "properties": { "id": { "description": "IANA Time Zone Database time zone. For example \"America/New_York\".", "type": "string" }, "version": { "type": "string", "description": "Optional. IANA Time Zone Database version number. For example \"2019a\"." } }, "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", "type": "object", "id": "TimeZone" }, "Status": { "properties": { "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "details": { "type": "array", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." } }, "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "id": "Status" }, "GoogleCloudFinancialservicesV1CopyModelRequest": { "properties": { "modelId": { "description": "Required. The resource id of the Model that the copy operation is creating.", "type": "string" }, "sourceModel": { "type": "string", "description": "Required. The resource name of the Model to copy." } }, "description": "Request for copying a model from a different AML AI instance.", "type": "object", "id": "GoogleCloudFinancialservicesV1CopyModelRequest" }, "GoogleCloudFinancialservicesV1ListInstancesResponse": { "properties": { "instances": { "type": "array", "items": { "$ref": "GoogleCloudFinancialservicesV1Instance" }, "description": "List of Instance resources" }, "nextPageToken": { "type": "string", "description": "This token should be passed to the next ListInstancesRequest to retrieve the next page of Instances." }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } }, "description": "Response for retrieving a list of Instances", "type": "object", "id": "GoogleCloudFinancialservicesV1ListInstancesResponse" }, "GoogleCloudFinancialservicesV1EngineConfigHyperparameterSource": { "description": "Parameters for bootstrapping an Engine Config with the results of another one.", "properties": { "sourceEngineConfig": { "type": "string", "description": "Required. The resource name of the source EngineConfig whose outputs are used. Format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`" }, "sourceEngineVersion": { "description": "Output only. The resource name of the EngineVersion that was used in the tuning run. Format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`", "readOnly": true, "type": "string" } }, "id": "GoogleCloudFinancialservicesV1EngineConfigHyperparameterSource", "type": "object" }, "GoogleCloudFinancialservicesV1ImportRegisteredPartiesRequest": { "type": "object", "id": "GoogleCloudFinancialservicesV1ImportRegisteredPartiesRequest", "properties": { "validateOnly": { "type": "boolean", "description": "Optional. If the request will not register the parties, just determine what would happen." }, "lineOfBusiness": { "type": "string", "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ], "description": "Required. LineOfBusiness for the specified registered parties.", "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ] }, "partyTables": { "description": "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", "type": "array", "items": { "type": "string" } }, "mode": { "type": "string", "enumDescriptions": [ "Default mode.", "Replace parties that are removable in Parties Table with new parties.", "Add new parties to Parties Table." ], "enum": [ "UPDATE_MODE_UNSPECIFIED", "REPLACE", "APPEND" ], "description": "Required. Mode of the request." } }, "description": "Request for adding/removing registered parties from BigQuery tables specified by the customer." }, "CancelOperationRequest": { "id": "CancelOperationRequest", "type": "object", "description": "The request message for Operations.CancelOperation.", "properties": {} }, "Location": { "type": "object", "id": "Location", "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "type": "object", "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" } } }, "description": "A resource that represents a Google Cloud location." }, "Operation": { "properties": { "done": { "type": "boolean", "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available." }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "metadata": { "type": "object", "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" } }, "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "id": "Operation" }, "GoogleCloudFinancialservicesV1ExportRegisteredPartiesRequest": { "type": "object", "id": "GoogleCloudFinancialservicesV1ExportRegisteredPartiesRequest", "properties": { "dataset": { "description": "Required. The location to output the RegisteredParties.", "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination" }, "lineOfBusiness": { "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ], "description": "Required. LineOfBusiness to get RegisteredParties from.", "type": "string", "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ] } }, "description": "Request to export a list of currently registered parties." }, "ListOperationsResponse": { "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } } }, "description": "The response message for Operations.ListOperations.", "type": "object", "id": "ListOperationsResponse" }, "GoogleCloudFinancialservicesV1Instance": { "id": "GoogleCloudFinancialservicesV1Instance", "type": "object", "description": "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.", "properties": { "labels": { "description": "Labels", "additionalProperties": { "type": "string" }, "type": "object" }, "validPartyRegistrationSharingConsumerInstances": { "description": "Optional. The resource names of AML instances which are valid Party Registration Sharing Consumers. format: `projects/{project_num}/locations/{location}/instances/{instance}` The listed instances will be able to generate Prediction Results for parties registered in this instance if they also specify this instance as the `party_registration_sharing_host_instance`. Parties can only be shared within the same Cloud region. Only one of `valid_party_registration_sharing_consumer_instances` or `party_registration_sharing_host_instance` may be specified.", "type": "array", "items": { "type": "string" } }, "name": { "description": "Output only. The full path to the Instance resource in this API. format: `projects/{project}/locations/{location}/instances/{instance}`", "readOnly": true, "type": "string" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when the Instance was last updated. Assigned by the server." }, "state": { "readOnly": true, "type": "string", "enumDescriptions": [ "State is unspecified, should not occur.", "The resource has not finished being created.", "The resource is active/ready to be used.", "The resource is in the process of being updated.", "The resource is in the process of being deleted." ], "description": "Output only. State of the instance. Assigned by the server.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING" ] }, "satisfiesPzi": { "description": "Output only. [Output Only] Reserved for future use.", "readOnly": true, "type": "boolean" }, "createTime": { "description": "Output only. Timestamp when the Instance was created. Assigned by the server.", "readOnly": true, "type": "string", "format": "google-datetime" }, "partyRegistrationSharingHostInstance": { "type": "string", "description": "Optional. The resource name of this instance's Party Registration Sharing Host instance. format: `projects/{project_num}/locations/{location}/instances/{instance}` If the host instance has listed this instance in its `valid_party_registration_sharing_consumer_instances` field, then registration sharing will be enabled. That means this instance can generate predictions for parties registered in the host instance. Any parties registered in this instance should be deregistered at the earliest opportunity to avoid unnecessary charges. Parties can only be shared within the same Cloud region. Only one of `valid_party_registration_sharing_consumer_instances` or `party_registration_sharing_host_instance` may be specified." }, "satisfiesPzs": { "description": "Output only. [Output Only] Reserved for future use.", "readOnly": true, "type": "boolean" }, "kmsKey": { "type": "string", "description": "Required. The KMS key name used for CMEK (encryption-at-rest). format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}` VPC-SC restrictions apply." } } }, "GoogleCloudFinancialservicesV1BigQueryDestination": { "description": "BigQueryDestination is a wrapper for BigQuery output information.", "properties": { "tableUri": { "type": "string", "description": "Optional. BigQuery URI to a table, must be of the form bq://projectId.bqDatasetId.tableId. Note that the BigQuery dataset must already exist. VPC-SC restrictions apply." }, "writeDisposition": { "type": "string", "enumDescriptions": [ "Default behavior is the same as WRITE_EMPTY.", "If the table already exists and contains data, an error is returned.", "If the table already exists, the data will be overwritten." ], "description": "Required. Whether or not to overwrite the destination table. By default the table won't be overwritten and an error will be returned if the table exists and contains data.", "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_EMPTY", "WRITE_TRUNCATE" ] } }, "id": "GoogleCloudFinancialservicesV1BigQueryDestination", "type": "object" }, "GoogleCloudFinancialservicesV1ListModelsResponse": { "id": "GoogleCloudFinancialservicesV1ListModelsResponse", "type": "object", "description": "Response for retrieving a list of Models", "properties": { "models": { "description": "List of Model resources", "type": "array", "items": { "$ref": "GoogleCloudFinancialservicesV1Model" } }, "nextPageToken": { "description": "This token should be passed to the next ListModelsRequest to retrieve the next page of Models (empty indicicates we are done).", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudFinancialservicesV1PredictionResultOutputs": { "id": "GoogleCloudFinancialservicesV1PredictionResultOutputs", "type": "object", "description": "Outputs is a list of places where the operation will write results.", "properties": { "predictionDestination": { "description": "Required. The location to output the predictions.", "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination" }, "explainabilityDestination": { "description": "The location to output explainability information. If not specified no explainability data will be output.", "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination" } } }, "Empty": { "properties": {}, "description": "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); }", "type": "object", "id": "Empty" }, "GoogleCloudFinancialservicesV1EngineConfigPerformanceTarget": { "id": "GoogleCloudFinancialservicesV1EngineConfigPerformanceTarget", "type": "object", "description": "PerformanceTarget gives hints on how to evaluate the performance of a model.", "properties": { "partyInvestigationsPerPeriodHint": { "type": "string", "format": "int64", "description": "Required. A number that gives the tuner a hint on the number of parties from this data that will be investigated per period (monthly). This is used to control how the model is evaluated. For example, when trying AML AI for the first time, we recommend setting this to the number of parties investigated in an average month, based on alerts from your existing automated alerting system." } } } }, "ownerName": "Google", "description": "", "servicePath": "", "kind": "discovery#restDescription", "mtlsRootUrl": "https://financialservices.mtls.googleapis.com/", "canonicalName": "Financial Services", "parameters": { "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, "alt": { "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "default": "json" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "location": "query", "type": "boolean", "default": "true" }, "$.xgafv": { "location": "query", "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "enum": [ "1", "2" ], "description": "V1 error format." }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" } }, "version_module": true, "protocol": "rest", "fullyEncodeReservedExpansion": true, "discoveryVersion": "v1", "name": "financialservices", "id": "financialservices:v1", "basePath": "", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "id": "financialservices.projects.locations.list", "parameterOrder": [ "name" ], "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "response": { "$ref": "ListLocationsResponse" }, "path": "v1/{+name}/locations", "flatPath": "v1/projects/{projectsId}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "extraLocationTypes": { "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query" }, "name": { "description": "The resource that owns the locations collection, if applicable.", "type": "string", "pattern": "^projects/[^/]+$", "location": "path", "required": true }, "filter": { "type": "string", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query" } } }, "get": { "httpMethod": "GET", "parameters": { "name": { "description": "Resource name for the location.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "path": "v1/{+name}", "response": { "$ref": "Location" }, "description": "Gets information about a location.", "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.get" } }, "resources": { "operations": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "The name of the operation's parent resource." }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageSize": { "type": "integer", "format": "int32", "description": "The standard list page size.", "location": "query" } }, "response": { "$ref": "ListOperationsResponse" }, "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "financialservices.projects.locations.operations.list", "parameterOrder": [ "name" ] }, "delete": { "response": { "$ref": "Empty" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true } }, "id": "financialservices.projects.locations.operations.delete", "parameterOrder": [ "name" ], "description": "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`." }, "get": { "response": { "$ref": "Operation" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "The name of the operation resource." } }, "id": "financialservices.projects.locations.operations.get", "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "cancel": { "path": "v1/{+name}:cancel", "request": { "$ref": "CancelOperationRequest" }, "response": { "$ref": "Empty" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true } }, "id": "financialservices.projects.locations.operations.cancel", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." } } }, "instances": { "methods": { "create": { "path": "v1/{+parent}/instances", "request": { "$ref": "GoogleCloudFinancialservicesV1Instance" }, "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance." }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "instanceId": { "type": "string", "description": "Required. The resource id of the instance.", "location": "query" } }, "id": "financialservices.projects.locations.instances.create", "parameterOrder": [ "parent" ], "description": "Creates an instance." }, "patch": { "path": "v1/{+name}", "request": { "$ref": "GoogleCloudFinancialservicesV1Instance" }, "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "parameters": { "requestId": { "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" }, "name": { "description": "Output only. The full path to the Instance resource in this API. format: `projects/{project}/locations/{location}/instances/{instance}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "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.", "location": "query" } }, "id": "financialservices.projects.locations.instances.patch", "parameterOrder": [ "name" ], "description": "Updates the parameters of a single Instance." }, "get": { "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.instances.get", "description": "Gets an instance.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "response": { "$ref": "GoogleCloudFinancialservicesV1Instance" }, "path": "v1/{+name}", "httpMethod": "GET", "parameters": { "name": { "type": "string", "description": "Required. The resource name of the Instance.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances", "path": "v1/{+parent}/instances", "response": { "$ref": "GoogleCloudFinancialservicesV1ListInstancesResponse" }, "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance." }, "filter": { "description": "Specify a filter to narrow search results.", "location": "query", "type": "string" }, "orderBy": { "type": "string", "description": "Specify a field to use for ordering.", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "The number of resources to be included in the response. The response contains a next_page_token, which can be used to retrieve the next page of resources.", "location": "query" }, "pageToken": { "description": "In case of paginated results, this is the token that was returned in the previous ListInstancesResponse. It should be copied here to retrieve the next page of resources. This will be empty for the first instance of ListInstancesRequest.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "financialservices.projects.locations.instances.list", "description": "Lists instances." }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the Instance.", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "path": "v1/{+name}", "response": { "$ref": "Operation" }, "description": "Deletes an instance.", "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.instances.delete" }, "exportRegisteredParties": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:exportRegisteredParties", "path": "v1/{+name}:exportRegisteredParties", "request": { "$ref": "GoogleCloudFinancialservicesV1ExportRegisteredPartiesRequest" }, "response": { "$ref": "Operation" }, "httpMethod": "POST", "parameters": { "name": { "type": "string", "description": "Required. The full path to the Instance resource in this API. format: `projects/{project}/locations/{location}/instances/{instance}`", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.instances.exportRegisteredParties", "description": "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." }, "importRegisteredParties": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:importRegisteredParties", "response": { "$ref": "Operation" }, "path": "v1/{+name}:importRegisteredParties", "request": { "$ref": "GoogleCloudFinancialservicesV1ImportRegisteredPartiesRequest" }, "httpMethod": "POST", "parameters": { "name": { "description": "Required. The full path to the Instance resource in this API. format: `projects/{project}/locations/{location}/instances/{instance}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.instances.importRegisteredParties", "description": "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." } }, "resources": { "backtestResults": { "methods": { "get": { "description": "Gets a BacktestResult.", "id": "financialservices.projects.locations.instances.backtestResults.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backtestResults/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the BacktestResult", "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "GoogleCloudFinancialservicesV1BacktestResult" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backtestResults/{backtestResultsId}" }, "create": { "parameterOrder": [ "parent" ], "id": "financialservices.projects.locations.instances.backtestResults.create", "description": "Create a BacktestResult.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backtestResults", "path": "v1/{+parent}/backtestResults", "request": { "$ref": "GoogleCloudFinancialservicesV1BacktestResult" }, "response": { "$ref": "Operation" }, "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true, "description": "Required. The parent of the BacktestResult is the Instance.", "type": "string" }, "backtestResultId": { "description": "Required. The resource id of the BacktestResult", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backtestResults/[^/]+$", "location": "path", "required": true, "description": "Output only. The resource name of the BacktestResult. format: `/projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}`", "type": "string" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "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.", "location": "query" }, "requestId": { "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } }, "response": { "$ref": "Operation" }, "path": "v1/{+name}", "request": { "$ref": "GoogleCloudFinancialservicesV1BacktestResult" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backtestResults/{backtestResultsId}", "description": "Updates the parameters of a single BacktestResult.", "id": "financialservices.projects.locations.instances.backtestResults.patch", "parameterOrder": [ "name" ] }, "exportMetadata": { "httpMethod": "POST", "parameters": { "backtestResult": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backtestResults/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the BacktestResult.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backtestResults/{backtestResultsId}:exportMetadata", "path": "v1/{+backtestResult}:exportMetadata", "request": { "$ref": "GoogleCloudFinancialservicesV1ExportBacktestResultMetadataRequest" }, "response": { "$ref": "Operation" }, "description": "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).", "parameterOrder": [ "backtestResult" ], "id": "financialservices.projects.locations.instances.backtestResults.exportMetadata" }, "list": { "parameterOrder": [ "parent" ], "id": "financialservices.projects.locations.instances.backtestResults.list", "description": "List BacktestResults.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backtestResults", "response": { "$ref": "GoogleCloudFinancialservicesV1ListBacktestResultsResponse" }, "path": "v1/{+parent}/backtestResults", "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true, "description": "Required. The parent of the BacktestResult is the Instance.", "type": "string" }, "filter": { "type": "string", "description": "Specify a filter to narrow search results.", "location": "query" }, "orderBy": { "description": "Specify a field to use for ordering.", "location": "query", "type": "string" }, "pageSize": { "description": "The number of resources to be included in the response. The response contains a next_page_token, which can be used to retrieve the next page of resources.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "In case of paginated results, this is the token that was returned in the previous ListBacktestResultsResponse. It should be copied here to retrieve the next page of resources. Empty will give the first page of ListBacktestResultsRequest, and the last page will return an empty page_token.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backtestResults/{backtestResultsId}", "path": "v1/{+name}", "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "description": "Required. The resource name of the BacktestResult.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backtestResults/[^/]+$", "location": "path", "required": true }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.instances.backtestResults.delete", "description": "Deletes a BacktestResult." } } }, "engineConfigs": { "methods": { "list": { "description": "Lists engine configs.", "id": "financialservices.projects.locations.instances.engineConfigs.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent of the EngineConfig is the Instance." }, "filter": { "type": "string", "description": "Specify a filter to narrow search results.", "location": "query" }, "pageToken": { "description": "In case of paginated results, this is the token that was returned in the previous ListEngineConfigsResponse. It should be copied here to retrieve the next page of resources. Empty will give the first page of ListEngineConfigsRequest, and the last page will return an empty page_token.", "location": "query", "type": "string" }, "orderBy": { "description": "Specify a field to use for ordering.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "The number of resources to be included in the response. The response contains a next_page_token, which can be used to retrieve the next page of resources.", "location": "query" } }, "response": { "$ref": "GoogleCloudFinancialservicesV1ListEngineConfigsResponse" }, "path": "v1/{+parent}/engineConfigs", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineConfigs" }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the EngineConfig.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/engineConfigs/[^/]+$", "location": "path", "required": true }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineConfigs/{engineConfigsId}", "response": { "$ref": "Operation" }, "path": "v1/{+name}", "description": "Deletes an engine config.", "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.instances.engineConfigs.delete" }, "get": { "id": "financialservices.projects.locations.instances.engineConfigs.get", "parameterOrder": [ "name" ], "description": "Gets an engine config.", "response": { "$ref": "GoogleCloudFinancialservicesV1EngineConfig" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineConfigs/{engineConfigsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "type": "string", "description": "Required. The resource name of the EngineConfig", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/engineConfigs/[^/]+$", "location": "path", "required": true } } }, "create": { "parameterOrder": [ "parent" ], "id": "financialservices.projects.locations.instances.engineConfigs.create", "description": "Creates an engine config.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineConfigs", "path": "v1/{+parent}/engineConfigs", "request": { "$ref": "GoogleCloudFinancialservicesV1EngineConfig" }, "response": { "$ref": "Operation" }, "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent of the EngineConfig is the Instance." }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "engineConfigId": { "description": "Required. The resource id of the EngineConfig", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "path": "v1/{+name}", "request": { "$ref": "GoogleCloudFinancialservicesV1EngineConfig" }, "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineConfigs/{engineConfigsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "parameters": { "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "updateMask": { "description": "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.", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/engineConfigs/[^/]+$", "location": "path", "required": true, "description": "Output only. The resource name of the EngineConfig. format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`", "type": "string" } }, "id": "financialservices.projects.locations.instances.engineConfigs.patch", "parameterOrder": [ "name" ], "description": "Updates the parameters of a single EngineConfig." }, "exportMetadata": { "parameterOrder": [ "engineConfig" ], "id": "financialservices.projects.locations.instances.engineConfigs.exportMetadata", "description": "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).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineConfigs/{engineConfigsId}:exportMetadata", "path": "v1/{+engineConfig}:exportMetadata", "request": { "$ref": "GoogleCloudFinancialservicesV1ExportEngineConfigMetadataRequest" }, "response": { "$ref": "Operation" }, "httpMethod": "POST", "parameters": { "engineConfig": { "description": "Required. The resource name of the EngineConfig.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/engineConfigs/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "models": { "methods": { "copy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "parent": { "type": "string", "description": "Required. The parent of the Model is the Instance.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true } }, "path": "v1/{+parent}/models:copy", "request": { "$ref": "GoogleCloudFinancialservicesV1CopyModelRequest" }, "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/models:copy", "description": "Copies a model from one instance to another. See the [model copy documentation](https://docs.cloud.google.com/financial-services/anti-money-laundering/docs/copy-model-instances) for more information.", "id": "financialservices.projects.locations.instances.models.copy", "parameterOrder": [ "parent" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true, "description": "Required. The parent of the Model is the Instance.", "type": "string" }, "filter": { "type": "string", "description": "Specify a filter to narrow search results.", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "The number of resources to be included in the response. The response contains a next_page_token, which can be used to retrieve the next page of resources.", "location": "query" }, "orderBy": { "description": "Specify a field to use for ordering.", "location": "query", "type": "string" }, "pageToken": { "description": "In case of paginated results, this is the token that was returned in the previous ListModelsResponse. It should be copied here to retrieve the next page of resources. Empty will give the first page of ListModelsRequest, and the last page will return an empty page_token.", "location": "query", "type": "string" } }, "response": { "$ref": "GoogleCloudFinancialservicesV1ListModelsResponse" }, "path": "v1/{+parent}/models", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/models", "description": "Lists models.", "id": "financialservices.projects.locations.instances.models.list", "parameterOrder": [ "parent" ] }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/models/{modelsId}", "response": { "$ref": "Operation" }, "path": "v1/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "description": "Required. The resource name of the Model.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/models/[^/]+$", "location": "path", "required": true }, "requestId": { "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.instances.models.delete", "description": "Deletes a model." }, "get": { "response": { "$ref": "GoogleCloudFinancialservicesV1Model" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/models/{modelsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/models/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The resource name of the Model" } }, "id": "financialservices.projects.locations.instances.models.get", "parameterOrder": [ "name" ], "description": "Gets a model." }, "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/models", "path": "v1/{+parent}/models", "request": { "$ref": "GoogleCloudFinancialservicesV1Model" }, "response": { "$ref": "Operation" }, "httpMethod": "POST", "parameters": { "modelId": { "type": "string", "description": "Required. The resource id of the Model", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true, "description": "Required. The parent of the Model is the Instance.", "type": "string" }, "requestId": { "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "financialservices.projects.locations.instances.models.create", "description": "Creates a model." }, "patch": { "description": "Updates the parameters of a single Model.", "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.instances.models.patch", "httpMethod": "PATCH", "parameters": { "updateMask": { "description": "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.", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "type": "string", "description": "Output only. The resource name of the Model. format: `/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}`", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/models/[^/]+$", "location": "path", "required": true }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/models/{modelsId}", "response": { "$ref": "Operation" }, "path": "v1/{+name}", "request": { "$ref": "GoogleCloudFinancialservicesV1Model" } }, "exportMetadata": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "model": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/models/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the Model.", "type": "string" } }, "response": { "$ref": "Operation" }, "path": "v1/{+model}:exportMetadata", "request": { "$ref": "GoogleCloudFinancialservicesV1ExportModelMetadataRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/models/{modelsId}:exportMetadata", "description": "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).", "id": "financialservices.projects.locations.instances.models.exportMetadata", "parameterOrder": [ "model" ] } } }, "predictionResults": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "orderBy": { "description": "Specify a field to use for ordering.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "The number of resources to be included in the response. The response contains a next_page_token, which can be used to retrieve the next page of resources.", "location": "query" }, "pageToken": { "description": "In case of paginated results, this is the token that was returned in the previous ListPredictionResultsResponse. It should be copied here to retrieve the next page of resources. Empty will give the first page of ListPredictionResultsRequest, and the last page will return an empty page_token.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent of the PredictionResult is the Instance." }, "filter": { "type": "string", "description": "Specify a filter to narrow search results.", "location": "query" } }, "path": "v1/{+parent}/predictionResults", "response": { "$ref": "GoogleCloudFinancialservicesV1ListPredictionResultsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/predictionResults", "description": "List PredictionResults.", "id": "financialservices.projects.locations.instances.predictionResults.list", "parameterOrder": [ "parent" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the PredictionResult.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/predictionResults/[^/]+$", "location": "path", "required": true }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/predictionResults/{predictionResultsId}", "description": "Deletes a PredictionResult.", "id": "financialservices.projects.locations.instances.predictionResults.delete", "parameterOrder": [ "name" ] }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/predictionResults/{predictionResultsId}", "response": { "$ref": "GoogleCloudFinancialservicesV1PredictionResult" }, "path": "v1/{+name}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the PredictionResult", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/predictionResults/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.instances.predictionResults.get", "description": "Gets a PredictionResult." }, "create": { "id": "financialservices.projects.locations.instances.predictionResults.create", "parameterOrder": [ "parent" ], "description": "Create a PredictionResult.", "path": "v1/{+parent}/predictionResults", "request": { "$ref": "GoogleCloudFinancialservicesV1PredictionResult" }, "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/predictionResults", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent of the PredictionResult is the Instance.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "predictionResultId": { "description": "Required. The resource id of the PredictionResult", "location": "query", "type": "string" } } }, "patch": { "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/predictionResults/[^/]+$", "location": "path", "required": true, "description": "Output only. The resource name of the PredictionResult. format: `/projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}`", "type": "string" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "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.", "location": "query" }, "requestId": { "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/predictionResults/{predictionResultsId}", "response": { "$ref": "Operation" }, "path": "v1/{+name}", "request": { "$ref": "GoogleCloudFinancialservicesV1PredictionResult" }, "description": "Updates the parameters of a single PredictionResult.", "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.instances.predictionResults.patch" }, "exportMetadata": { "id": "financialservices.projects.locations.instances.predictionResults.exportMetadata", "parameterOrder": [ "predictionResult" ], "description": "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).", "response": { "$ref": "Operation" }, "path": "v1/{+predictionResult}:exportMetadata", "request": { "$ref": "GoogleCloudFinancialservicesV1ExportPredictionResultMetadataRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/predictionResults/{predictionResultsId}:exportMetadata", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "predictionResult": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/predictionResults/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the PredictionResult.", "type": "string" } } } } }, "datasets": { "methods": { "get": { "description": "Gets a dataset.", "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.instances.datasets.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/datasets/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the Dataset", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/datasets/{datasetsId}", "path": "v1/{+name}", "response": { "$ref": "GoogleCloudFinancialservicesV1Dataset" } }, "create": { "id": "financialservices.projects.locations.instances.datasets.create", "parameterOrder": [ "parent" ], "description": "Creates a dataset.", "response": { "$ref": "Operation" }, "path": "v1/{+parent}/datasets", "request": { "$ref": "GoogleCloudFinancialservicesV1Dataset" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/datasets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "datasetId": { "description": "Required. The resource id of the dataset", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true, "description": "Required. The parent of the Dataset is the Instance.", "type": "string" }, "requestId": { "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } } }, "patch": { "description": "Updates the parameters of a single Dataset.", "id": "financialservices.projects.locations.instances.datasets.patch", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "parameters": { "name": { "description": "Output only. Identifier. The resource name of the Dataset. format: `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/datasets/[^/]+$", "location": "path", "required": true }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "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.", "location": "query" }, "requestId": { "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } }, "path": "v1/{+name}", "request": { "$ref": "GoogleCloudFinancialservicesV1Dataset" }, "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/datasets/{datasetsId}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true, "description": "Required. The parent of the Dataset is the Instance.", "type": "string" }, "filter": { "description": "Optional. Specify a filter to narrow search results.", "location": "query", "type": "string" }, "orderBy": { "type": "string", "description": "Optional. Specify a field to use for ordering.", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The number of resources to be included in the response. The response contains a next_page_token, which can be used to retrieve the next page of resources.", "location": "query" }, "pageToken": { "type": "string", "description": "Optional. In case of paginated results, this is the token that was returned in the previous ListDatasetResponse. It should be copied here to retrieve the next page of resources. Empty will give the first page of ListDatasetRequest, and the last page will return an empty page_token.", "location": "query" } }, "response": { "$ref": "GoogleCloudFinancialservicesV1ListDatasetsResponse" }, "path": "v1/{+parent}/datasets", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/datasets", "description": "Lists datasets.", "id": "financialservices.projects.locations.instances.datasets.list", "parameterOrder": [ "parent" ] }, "delete": { "id": "financialservices.projects.locations.instances.datasets.delete", "parameterOrder": [ "name" ], "description": "Deletes a dataset.", "path": "v1/{+name}", "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/datasets/{datasetsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the Dataset.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/datasets/[^/]+$", "location": "path", "required": true }, "requestId": { "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } } } } }, "engineVersions": { "methods": { "get": { "description": "Gets a single EngineVersion.", "id": "financialservices.projects.locations.instances.engineVersions.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/engineVersions/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The resource name of the EngineVersion" } }, "response": { "$ref": "GoogleCloudFinancialservicesV1EngineVersion" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineVersions/{engineVersionsId}" }, "list": { "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent of the EngineVersion is the Instance.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true }, "filter": { "description": "Optional. Specify a filter to narrow search results. If empty or unset will default to \"state!=DEPRECATED\", to view deprecated versions use \"state:*\" or any other filter.", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. In case of paginated results, this is the token that was returned in the previous ListEngineVersionsResponse. It should be copied here to retrieve the next page of resources. Empty will give the first page of ListEngineVersionsRequest, and the last page will return an empty page_token.", "location": "query", "type": "string" }, "orderBy": { "type": "string", "description": "Optional. Specify a field to use for ordering.", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The number of resources to be included in the response. The response contains a next_page_token, which can be used to retrieve the next page of resources.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineVersions", "response": { "$ref": "GoogleCloudFinancialservicesV1ListEngineVersionsResponse" }, "path": "v1/{+parent}/engineVersions", "description": "Lists EngineVersions for given location.", "parameterOrder": [ "parent" ], "id": "financialservices.projects.locations.instances.engineVersions.list" } } } } } } } } } }, "title": "Financial Services API", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "batchPath": "batch", "revision": "20260324", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "version": "v1", "ownerDomain": "google.com", "baseUrl": "https://financialservices.googleapis.com/", "documentationLink": "https://cloud.google.com/solutions/financial-services", "rootUrl": "https://financialservices.googleapis.com/" }