{ "ownerDomain": "google.com", "title": "Financial Services API", "revision": "20260818", "version_module": true, "canonicalName": "Financial Services", "fullyEncodeReservedExpansion": true, "ownerName": "Google", "name": "financialservices", "batchPath": "batch", "parameters": { "callback": { "type": "string", "description": "JSONP", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "$.xgafv": { "enum": [ "1", "2" ], "type": "string", "location": "query", "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "quotaUser": { "type": "string", "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" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "key": { "location": "query", "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.", "type": "string" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "alt": { "enum": [ "json", "media", "proto" ], "type": "string", "location": "query", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "description": "Data format for response.", "default": "json" }, "prettyPrint": { "location": "query", "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean" } }, "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." } } } }, "kind": "discovery#restDescription", "mtlsRootUrl": "https://financialservices.mtls.googleapis.com/", "rootUrl": "https://financialservices.googleapis.com/", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "id": "financialservices:v1", "resources": { "projects": { "resources": { "locations": { "resources": { "operations": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}/operations", "id": "financialservices.projects.locations.operations.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "response": { "$ref": "ListOperationsResponse" }, "parameters": { "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageSize": { "location": "query", "type": "integer", "description": "The standard list page size.", "format": "int32" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "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." }, "name": { "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "cancel": { "request": { "$ref": "CancelOperationRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "financialservices.projects.locations.operations.cancel", "parameterOrder": [ "name" ], "path": "v1/{+name}:cancel", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path" } }, "response": { "$ref": "Empty" }, "httpMethod": "POST", "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`." }, "get": { "id": "financialservices.projects.locations.operations.get", "response": { "$ref": "Operation" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "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.", "parameterOrder": [ "name" ], "path": "v1/{+name}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "id": "financialservices.projects.locations.operations.delete", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" }, "path": "v1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "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`." } } }, "instances": { "methods": { "get": { "description": "Gets an instance.", "response": { "$ref": "GoogleCloudFinancialservicesV1Instance" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "httpMethod": "GET", "path": "v1/{+name}", "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.instances.get", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "type": "string", "required": true, "description": "Required. The resource name of the Instance." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "importRegisteredParties": { "path": "v1/{+name}:importRegisteredParties", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The full path to the Instance resource in this API. format: `projects/{project}/locations/{location}/instances/{instance}`" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.instances.importRegisteredParties", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:importRegisteredParties", "response": { "$ref": "Operation" }, "request": { "$ref": "GoogleCloudFinancialservicesV1ImportRegisteredPartiesRequest" }, "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." }, "list": { "path": "v1/{+parent}/instances", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudFinancialservicesV1ListInstancesResponse" }, "id": "financialservices.projects.locations.instances.list", "description": "Lists instances.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances", "parameterOrder": [ "parent" ], "parameters": { "orderBy": { "type": "string", "location": "query", "description": "Specify a field to use for ordering." }, "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance." }, "pageSize": { "type": "integer", "location": "query", "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.", "format": "int32" }, "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" }, "filter": { "type": "string", "location": "query", "description": "Specify a filter to narrow search results." } } }, "create": { "response": { "$ref": "Operation" }, "description": "Creates an instance.", "id": "financialservices.projects.locations.instances.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances", "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" }, "instanceId": { "description": "Required. The resource id of the instance.", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance.", "required": true } }, "httpMethod": "POST", "path": "v1/{+parent}/instances", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudFinancialservicesV1Instance" } }, "exportRegisteredParties": { "httpMethod": "POST", "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.", "request": { "$ref": "GoogleCloudFinancialservicesV1ExportRegisteredPartiesRequest" }, "id": "financialservices.projects.locations.instances.exportRegisteredParties", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "description": "Required. The full path to the Instance resource in this API. format: `projects/{project}/locations/{location}/instances/{instance}`", "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" }, "path": "v1/{+name}:exportRegisteredParties", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:exportRegisteredParties" }, "patch": { "request": { "$ref": "GoogleCloudFinancialservicesV1Instance" }, "parameters": { "name": { "required": true, "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" }, "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).", "type": "string", "location": "query" }, "updateMask": { "format": "google-fieldmask", "location": "query", "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.", "type": "string" } }, "path": "v1/{+name}", "description": "Updates the parameters of a single Instance.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" }, "id": "financialservices.projects.locations.instances.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "httpMethod": "PATCH", "parameterOrder": [ "name" ] }, "delete": { "id": "financialservices.projects.locations.instances.delete", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", "path": "v1/{+name}", "description": "Deletes an instance.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "requestId": { "location": "query", "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).", "type": "string" }, "name": { "required": true, "description": "Required. The resource name of the Instance.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "type": "string", "location": "path" } } } }, "resources": { "engineVersions": { "methods": { "list": { "id": "financialservices.projects.locations.instances.engineVersions.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineVersions", "response": { "$ref": "GoogleCloudFinancialservicesV1ListEngineVersionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists EngineVersions for given location.", "path": "v1/{+parent}/engineVersions", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "description": "Required. The parent of the EngineVersion is the Instance.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "required": true }, "orderBy": { "description": "Optional. Specify a field to use for ordering.", "type": "string", "location": "query" }, "filter": { "location": "query", "type": "string", "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." }, "pageSize": { "location": "query", "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.", "format": "int32", "type": "integer" }, "pageToken": { "type": "string", "location": "query", "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." } } }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Gets a single EngineVersion.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/engineVersions/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the EngineVersion" } }, "path": "v1/{+name}", "response": { "$ref": "GoogleCloudFinancialservicesV1EngineVersion" }, "id": "financialservices.projects.locations.instances.engineVersions.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineVersions/{engineVersionsId}", "httpMethod": "GET" } } }, "datasets": { "methods": { "patch": { "parameters": { "name": { "required": true, "type": "string", "description": "Output only. Identifier. The resource name of the Dataset. format: `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/datasets/[^/]+$", "location": "path" }, "updateMask": { "location": "query", "format": "google-fieldmask", "type": "string", "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." }, "requestId": { "type": "string", "location": "query", "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)." } }, "id": "financialservices.projects.locations.instances.datasets.patch", "httpMethod": "PATCH", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/datasets/{datasetsId}", "description": "Updates the parameters of a single Dataset.", "response": { "$ref": "Operation" }, "path": "v1/{+name}", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudFinancialservicesV1Dataset" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "response": { "$ref": "GoogleCloudFinancialservicesV1Dataset" }, "parameters": { "name": { "location": "path", "description": "Required. The resource name of the Dataset", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/datasets/[^/]+$", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/datasets/{datasetsId}", "path": "v1/{+name}", "httpMethod": "GET", "id": "financialservices.projects.locations.instances.datasets.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Gets a dataset." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "orderBy": { "description": "Optional. Specify a field to use for ordering.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Specify a filter to narrow search results.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "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.", "format": "int32", "location": "query" }, "parent": { "description": "Required. The parent of the Dataset is the Instance.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "type": "string", "required": true }, "pageToken": { "location": "query", "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." } }, "response": { "$ref": "GoogleCloudFinancialservicesV1ListDatasetsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/datasets", "description": "Lists datasets.", "id": "financialservices.projects.locations.instances.datasets.list", "path": "v1/{+parent}/datasets", "parameterOrder": [ "parent" ] }, "delete": { "id": "financialservices.projects.locations.instances.datasets.delete", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/datasets/{datasetsId}", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/datasets/[^/]+$", "description": "Required. The resource name of the Dataset.", "type": "string", "required": true }, "requestId": { "type": "string", "location": "query", "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)." } }, "description": "Deletes a dataset.", "httpMethod": "DELETE" }, "create": { "parameters": { "datasetId": { "description": "Required. The resource id of the dataset", "type": "string", "location": "query" }, "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).", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent of the Dataset is the Instance.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "type": "string" } }, "request": { "$ref": "GoogleCloudFinancialservicesV1Dataset" }, "response": { "$ref": "Operation" }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/datasets", "id": "financialservices.projects.locations.instances.datasets.create", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/datasets", "description": "Creates a dataset." } } }, "models": { "methods": { "copy": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/models:copy", "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "id": "financialservices.projects.locations.instances.models.copy", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "type": "string", "required": true, "description": "Required. The parent of the Model is the Instance." } }, "request": { "$ref": "GoogleCloudFinancialservicesV1CopyModelRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/models:copy", "httpMethod": "POST", "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." }, "patch": { "path": "v1/{+name}", "id": "financialservices.projects.locations.instances.models.patch", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/models/{modelsId}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/models/[^/]+$", "description": "Output only. The resource name of the Model. format: `/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}`", "location": "path", "type": "string" }, "requestId": { "type": "string", "location": "query", "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)." }, "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.", "type": "string", "location": "query", "format": "google-fieldmask" } }, "description": "Updates the parameters of a single Model.", "request": { "$ref": "GoogleCloudFinancialservicesV1Model" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH" }, "list": { "parameters": { "parent": { "required": true, "description": "Required. The parent of the Model is the Instance.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "location": "path", "type": "string" }, "filter": { "location": "query", "description": "Specify a filter to narrow search results.", "type": "string" }, "pageToken": { "location": "query", "type": "string", "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." }, "orderBy": { "location": "query", "type": "string", "description": "Specify a field to use for ordering." }, "pageSize": { "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.", "type": "integer", "location": "query" } }, "description": "Lists models.", "path": "v1/{+parent}/models", "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudFinancialservicesV1ListModelsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/models", "id": "financialservices.projects.locations.instances.models.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/models/{modelsId}", "response": { "$ref": "GoogleCloudFinancialservicesV1Model" }, "parameters": { "name": { "location": "path", "description": "Required. The resource name of the Model", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/models/[^/]+$", "type": "string", "required": true } }, "description": "Gets a model.", "id": "financialservices.projects.locations.instances.models.get", "httpMethod": "GET" }, "create": { "response": { "$ref": "Operation" }, "id": "financialservices.projects.locations.instances.models.create", "description": "Creates a model.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/models", "request": { "$ref": "GoogleCloudFinancialservicesV1Model" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/models", "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" }, "parent": { "description": "Required. The parent of the Model is the Instance.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "type": "string", "location": "path" }, "modelId": { "description": "Required. The resource id of the Model", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/models/{modelsId}", "path": "v1/{+name}", "id": "financialservices.projects.locations.instances.models.delete", "parameterOrder": [ "name" ], "description": "Deletes a model.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/models/[^/]+$", "required": true, "location": "path", "description": "Required. The resource name of the Model.", "type": "string" }, "requestId": { "location": "query", "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)." } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "exportMetadata": { "path": "v1/{+model}:exportMetadata", "id": "financialservices.projects.locations.instances.models.exportMetadata", "httpMethod": "POST", "parameters": { "model": { "required": true, "description": "Required. The resource name of the Model.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/models/[^/]+$", "location": "path" } }, "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).", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "model" ], "request": { "$ref": "GoogleCloudFinancialservicesV1ExportModelMetadataRequest" } } } }, "backtestResults": { "methods": { "exportMetadata": { "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backtestResults/{backtestResultsId}:exportMetadata", "parameters": { "backtestResult": { "required": true, "description": "Required. The resource name of the BacktestResult.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backtestResults/[^/]+$", "location": "path", "type": "string" } }, "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", "path": "v1/{+backtestResult}:exportMetadata", "request": { "$ref": "GoogleCloudFinancialservicesV1ExportBacktestResultMetadataRequest" } }, "patch": { "request": { "$ref": "GoogleCloudFinancialservicesV1BacktestResult" }, "description": "Updates the parameters of a single BacktestResult.", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "financialservices.projects.locations.instances.backtestResults.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backtestResults/{backtestResultsId}", "path": "v1/{+name}", "response": { "$ref": "Operation" }, "parameters": { "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "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." }, "requestId": { "location": "query", "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)." }, "name": { "description": "Output only. The resource name of the BacktestResult. format: `/projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backtestResults/[^/]+$", "location": "path" } }, "parameterOrder": [ "name" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "requestId": { "location": "query", "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)." }, "name": { "type": "string", "required": true, "description": "Required. The resource name of the BacktestResult.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backtestResults/[^/]+$", "location": "path" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "id": "financialservices.projects.locations.instances.backtestResults.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backtestResults/{backtestResultsId}", "path": "v1/{+name}", "description": "Deletes a BacktestResult." }, "create": { "request": { "$ref": "GoogleCloudFinancialservicesV1BacktestResult" }, "description": "Create a BacktestResult.", "httpMethod": "POST", "parameters": { "requestId": { "type": "string", "location": "query", "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)." }, "parent": { "location": "path", "description": "Required. The parent of the BacktestResult is the Instance.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "type": "string" }, "backtestResultId": { "location": "query", "type": "string", "description": "Required. The resource id of the BacktestResult" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backtestResults", "response": { "$ref": "Operation" }, "id": "financialservices.projects.locations.instances.backtestResults.create", "path": "v1/{+parent}/backtestResults" }, "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List BacktestResults.", "path": "v1/{+parent}/backtestResults", "parameters": { "filter": { "type": "string", "description": "Specify a filter to narrow search results.", "location": "query" }, "orderBy": { "location": "query", "type": "string", "description": "Specify a field to use for ordering." }, "pageSize": { "location": "query", "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.", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "type": "string", "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." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "description": "Required. The parent of the BacktestResult is the Instance.", "location": "path", "type": "string" } }, "id": "financialservices.projects.locations.instances.backtestResults.list", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backtestResults", "response": { "$ref": "GoogleCloudFinancialservicesV1ListBacktestResultsResponse" } }, "get": { "path": "v1/{+name}", "response": { "$ref": "GoogleCloudFinancialservicesV1BacktestResult" }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backtestResults/{backtestResultsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a BacktestResult.", "id": "financialservices.projects.locations.instances.backtestResults.get", "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The resource name of the BacktestResult", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/backtestResults/[^/]+$" } } } } }, "predictionResults": { "methods": { "get": { "response": { "$ref": "GoogleCloudFinancialservicesV1PredictionResult" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/predictionResults/{predictionResultsId}", "parameters": { "name": { "description": "Required. The resource name of the PredictionResult", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/predictionResults/[^/]+$", "type": "string" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a PredictionResult.", "id": "financialservices.projects.locations.instances.predictionResults.get", "parameterOrder": [ "name" ] }, "exportMetadata": { "id": "financialservices.projects.locations.instances.predictionResults.exportMetadata", "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).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/predictionResults/{predictionResultsId}:exportMetadata", "path": "v1/{+predictionResult}:exportMetadata", "parameters": { "predictionResult": { "description": "Required. The resource name of the PredictionResult.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/predictionResults/[^/]+$", "type": "string", "required": true } }, "request": { "$ref": "GoogleCloudFinancialservicesV1ExportPredictionResultMetadataRequest" }, "response": { "$ref": "Operation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "predictionResult" ] }, "list": { "path": "v1/{+parent}/predictionResults", "parameters": { "filter": { "description": "Specify a filter to narrow search results.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "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.", "type": "integer" }, "pageToken": { "type": "string", "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" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "description": "Required. The parent of the PredictionResult is the Instance.", "type": "string", "location": "path" }, "orderBy": { "description": "Specify a field to use for ordering.", "type": "string", "location": "query" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "description": "List PredictionResults.", "id": "financialservices.projects.locations.instances.predictionResults.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/predictionResults", "response": { "$ref": "GoogleCloudFinancialservicesV1ListPredictionResultsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/predictionResults", "id": "financialservices.projects.locations.instances.predictionResults.create", "request": { "$ref": "GoogleCloudFinancialservicesV1PredictionResult" }, "path": "v1/{+parent}/predictionResults", "parameters": { "requestId": { "location": "query", "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)." }, "parent": { "description": "Required. The parent of the PredictionResult is the Instance.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" }, "predictionResultId": { "type": "string", "description": "Required. The resource id of the PredictionResult", "location": "query" } }, "description": "Create a PredictionResult.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "parent" ] }, "delete": { "id": "financialservices.projects.locations.instances.predictionResults.delete", "description": "Deletes a PredictionResult.", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/predictionResults/{predictionResultsId}", "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 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" }, "name": { "required": true, "type": "string", "description": "Required. The resource name of the PredictionResult.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/predictionResults/[^/]+$" } }, "path": "v1/{+name}", "response": { "$ref": "Operation" } }, "patch": { "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudFinancialservicesV1PredictionResult" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/predictionResults/{predictionResultsId}", "response": { "$ref": "Operation" }, "httpMethod": "PATCH", "parameters": { "requestId": { "location": "query", "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)." }, "updateMask": { "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.", "type": "string", "format": "google-fieldmask", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/predictionResults/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Output only. The resource name of the PredictionResult. format: `/projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}`" } }, "id": "financialservices.projects.locations.instances.predictionResults.patch", "description": "Updates the parameters of a single PredictionResult.", "path": "v1/{+name}" } } }, "engineConfigs": { "methods": { "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineConfigs/{engineConfigsId}", "response": { "$ref": "Operation" }, "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudFinancialservicesV1EngineConfig" }, "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "updateMask": { "format": "google-fieldmask", "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" }, "requestId": { "location": "query", "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).", "type": "string" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/engineConfigs/[^/]+$", "required": true, "type": "string", "description": "Output only. The resource name of the EngineConfig. format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`" } }, "parameterOrder": [ "name" ], "description": "Updates the parameters of a single EngineConfig.", "id": "financialservices.projects.locations.instances.engineConfigs.patch" }, "list": { "id": "financialservices.projects.locations.instances.engineConfigs.list", "parameters": { "pageSize": { "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.", "type": "integer", "location": "query" }, "orderBy": { "type": "string", "description": "Specify a field to use for ordering.", "location": "query" }, "filter": { "description": "Specify a filter to narrow search results.", "location": "query", "type": "string" }, "parent": { "description": "Required. The parent of the EngineConfig is the Instance.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", "required": true, "type": "string" }, "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.", "type": "string", "location": "query" } }, "httpMethod": "GET", "response": { "$ref": "GoogleCloudFinancialservicesV1ListEngineConfigsResponse" }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineConfigs", "path": "v1/{+parent}/engineConfigs", "description": "Lists engine configs.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineConfigs/{engineConfigsId}", "response": { "$ref": "GoogleCloudFinancialservicesV1EngineConfig" }, "description": "Gets an engine config.", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The resource name of the EngineConfig", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/engineConfigs/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "financialservices.projects.locations.instances.engineConfigs.get", "parameterOrder": [ "name" ], "httpMethod": "GET" }, "exportMetadata": { "request": { "$ref": "GoogleCloudFinancialservicesV1ExportEngineConfigMetadataRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "financialservices.projects.locations.instances.engineConfigs.exportMetadata", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineConfigs/{engineConfigsId}: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).", "httpMethod": "POST", "response": { "$ref": "Operation" }, "path": "v1/{+engineConfig}:exportMetadata", "parameterOrder": [ "engineConfig" ], "parameters": { "engineConfig": { "description": "Required. The resource name of the EngineConfig.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/engineConfigs/[^/]+$", "required": true } } }, "delete": { "path": "v1/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "Required. The resource name of the EngineConfig.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/engineConfigs/[^/]+$" }, "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" } }, "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineConfigs/{engineConfigsId}", "description": "Deletes an engine config.", "id": "financialservices.projects.locations.instances.engineConfigs.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "create": { "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/engineConfigs", "id": "financialservices.projects.locations.instances.engineConfigs.create", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudFinancialservicesV1EngineConfig" }, "description": "Creates an engine config.", "httpMethod": "POST", "parameters": { "engineConfigId": { "description": "Required. The resource id of the EngineConfig", "type": "string", "location": "query" }, "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent of the EngineConfig is the Instance.", "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$" }, "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).", "type": "string", "location": "query" } }, "path": "v1/{+parent}/engineConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } }, "methods": { "list": { "path": "v1/{+name}/locations", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "pageToken": { "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string" }, "filter": { "type": "string", "location": "query", "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)." }, "name": { "type": "string", "description": "The resource that owns the locations collection, if applicable.", "location": "path", "required": true, "pattern": "^projects/[^/]+$" }, "pageSize": { "type": "integer", "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query" }, "extraLocationTypes": { "type": "string", "location": "query", "repeated": true, "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage." } }, "flatPath": "v1/projects/{projectsId}/locations", "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.", "id": "financialservices.projects.locations.list", "response": { "$ref": "ListLocationsResponse" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "required": true, "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "path": "v1/{+name}", "description": "Gets information about a location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "response": { "$ref": "Location" }, "parameterOrder": [ "name" ], "id": "financialservices.projects.locations.get", "httpMethod": "GET" } } } } } }, "servicePath": "", "documentationLink": "https://cloud.google.com/solutions/financial-services", "discoveryVersion": "v1", "schemas": { "GoogleCloudFinancialservicesV1EngineConfigTuning": { "properties": { "endTime": { "format": "google-datetime", "type": "string", "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." }, "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" } }, "type": "object", "id": "GoogleCloudFinancialservicesV1EngineConfigTuning", "description": "The parameters needed for the tuning operation, these are used only in tuning and not passed on to training." }, "GoogleCloudFinancialservicesV1OperationMetadata": { "type": "object", "description": "Represents the metadata of the long-running operation.", "properties": { "statusMessage": { "readOnly": true, "description": "Output only. Human-readable status of the operation, if any.", "type": "string" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "requestedCancellation": { "type": "boolean", "readOnly": true, "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`." }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "type": "string", "readOnly": true }, "target": { "description": "Output only. Server-defined resource path for the target of the operation. format: \"/projects/{project}/...\" VPC-SC restrictions apply.", "readOnly": true, "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "format": "google-datetime", "readOnly": true, "type": "string" }, "apiVersion": { "description": "Output only. API version used to start the operation.", "type": "string", "readOnly": true } }, "id": "GoogleCloudFinancialservicesV1OperationMetadata" }, "GoogleCloudFinancialservicesV1Dataset": { "id": "GoogleCloudFinancialservicesV1Dataset", "description": "The Dataset resource contains summary information about a dataset.", "type": "object", "properties": { "name": { "type": "string", "description": "Output only. Identifier. The resource name of the Dataset. format: `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`", "readOnly": true }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING" ], "description": "Output only. State of the dataset (creating, active, deleting, etc.)", "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" }, "labels": { "description": "Optional. Labels", "type": "object", "additionalProperties": { "type": "string" } }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The timestamp of the most recent update of this resource.", "readOnly": true }, "tableSpecs": { "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" }, "type": "object" }, "timeZone": { "$ref": "TimeZone", "description": "Optional. The timezone of the data, default will act as UTC." }, "createTime": { "description": "Output only. The timestamp of creation of this resource.", "type": "string", "format": "google-datetime", "readOnly": true } } }, "Empty": { "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); }", "id": "Empty", "type": "object", "properties": {} }, "GoogleCloudFinancialservicesV1BacktestResult": { "description": "BacktestResult is created to test the performance of a model on a dataset.", "id": "GoogleCloudFinancialservicesV1BacktestResult", "properties": { "satisfiesPzs": { "type": "boolean", "description": "Output only. [Output Only] Reserved for future use.", "readOnly": true }, "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}`" }, "dataset": { "description": "Required. The resource name of the Dataset to backtest on Format: `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`", "type": "string" }, "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" }, "performanceTarget": { "description": "Required. PerformanceTarget gives information on how the test will be evaluated.", "$ref": "GoogleCloudFinancialservicesV1BacktestResultPerformanceTarget" }, "createTime": { "format": "google-datetime", "description": "Output only. The timestamp of creation of this resource.", "type": "string", "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}`" }, "updateTime": { "description": "Output only. The timestamp of the most recent update of this resource.", "type": "string", "readOnly": true, "format": "google-datetime" }, "lineOfBusiness": { "readOnly": true, "type": "string", "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ], "description": "Output only. The line of business (Retail/Commercial) this backtest is for. Determined by Model, cannot be set by user.", "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ] }, "labels": { "description": "Labels", "additionalProperties": { "type": "string" }, "type": "object" }, "state": { "description": "Output only. State of the BacktestResult (creating, active, deleting, etc.)", "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING" ], "readOnly": true, "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." ] }, "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." }, "satisfiesPzi": { "type": "boolean", "readOnly": true, "description": "Output only. [Output Only] Reserved for future use." } }, "type": "object" }, "GoogleCloudFinancialservicesV1ListModelsResponse": { "type": "object", "properties": { "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" }, "models": { "items": { "$ref": "GoogleCloudFinancialservicesV1Model" }, "type": "array", "description": "List of Model resources" }, "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Locations that could not be reached." } }, "description": "Response for retrieving a list of Models", "id": "GoogleCloudFinancialservicesV1ListModelsResponse" }, "GoogleCloudFinancialservicesV1CopyModelRequest": { "description": "Request for copying a model from a different AML AI instance.", "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." } }, "id": "GoogleCloudFinancialservicesV1CopyModelRequest", "type": "object" }, "GoogleCloudFinancialservicesV1ExportEngineConfigMetadataRequest": { "id": "GoogleCloudFinancialservicesV1ExportEngineConfigMetadataRequest", "properties": { "structuredMetadataDestination": { "description": "Required. BigQuery output where the metadata will be written.", "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination" } }, "type": "object", "description": "Request for exporting EngineConfig metadata." }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "unreachable": { "type": "array", "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.", "items": { "type": "string" } }, "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." } }, "id": "ListOperationsResponse" }, "GoogleCloudFinancialservicesV1ListInstancesResponse": { "id": "GoogleCloudFinancialservicesV1ListInstancesResponse", "description": "Response for retrieving a list of Instances", "type": "object", "properties": { "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.", "items": { "type": "string" }, "type": "array" }, "instances": { "type": "array", "items": { "$ref": "GoogleCloudFinancialservicesV1Instance" }, "description": "List of Instance resources" } } }, "GoogleCloudFinancialservicesV1EngineVersion": { "properties": { "expectedDecommissionTime": { "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.", "format": "google-datetime", "readOnly": true, "type": "string" }, "state": { "description": "Output only. The state of the version.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "LIMITED", "DECOMMISSIONED" ], "readOnly": true, "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." ] }, "name": { "readOnly": true, "description": "Output only. Identifier. The resource name of the EngineVersion format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`", "type": "string" }, "expectedLimitationStartTime": { "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.", "readOnly": true }, "lineOfBusiness": { "type": "string", "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ], "description": "Output only. The line of business (Retail/Commercial) this engine version is used for.", "readOnly": true, "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ] } }, "description": "EngineVersion controls which version of the engine is used to tune, train, and run the model.", "type": "object", "id": "GoogleCloudFinancialservicesV1EngineVersion" }, "GoogleCloudFinancialservicesV1Model": { "type": "object", "properties": { "endTime": { "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 training. End_time should be no later than the end of the date_range of the dataset.", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. The timestamp of creation of this resource.", "format": "google-datetime", "type": "string" }, "labels": { "description": "Labels", "additionalProperties": { "type": "string" }, "type": "object" }, "satisfiesPzs": { "type": "boolean", "readOnly": true, "description": "Output only. [Output Only] Reserved for future use." }, "engineConfig": { "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}`", "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" }, "sourceModel": { "readOnly": true, "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}`", "type": "string" }, "name": { "description": "Output only. The resource name of the Model. format: `/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}`", "type": "string", "readOnly": true }, "primaryDataset": { "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}`", "type": "string" }, "satisfiesPzi": { "type": "boolean", "description": "Output only. [Output Only] Reserved for future use.", "readOnly": true }, "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The timestamp of the most recent update of this resource." }, "lineOfBusiness": { "description": "Output only. The line of business (Retail/Commercial) this model is used for. Determined by EngineConfig, cannot be set by user.", "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ], "readOnly": true, "type": "string", "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ] }, "state": { "description": "Output only. State of the model (creating, active, deleting, etc.)", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING" ], "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." ], "type": "string", "readOnly": true } }, "id": "GoogleCloudFinancialservicesV1Model", "description": "Model represents a trained model." }, "GoogleCloudFinancialservicesV1PredictionResultOutputs": { "description": "Outputs is a list of places where the operation will write results.", "type": "object", "properties": { "predictionDestination": { "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination", "description": "Required. The location to output the predictions." }, "explainabilityDestination": { "description": "The location to output explainability information. If not specified no explainability data will be output.", "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination" } }, "id": "GoogleCloudFinancialservicesV1PredictionResultOutputs" }, "GoogleCloudFinancialservicesV1ListPredictionResultsResponse": { "type": "object", "description": "Response for retrieving a list of PredictionResults", "properties": { "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Locations that could not be reached." }, "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)." }, "predictionResults": { "items": { "$ref": "GoogleCloudFinancialservicesV1PredictionResult" }, "type": "array", "description": "List of PredictionResult resources" } }, "id": "GoogleCloudFinancialservicesV1ListPredictionResultsResponse" }, "GoogleCloudFinancialservicesV1BigQueryDestination": { "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": { "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_EMPTY", "WRITE_TRUNCATE" ], "type": "string", "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.", "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." ] } }, "type": "object", "id": "GoogleCloudFinancialservicesV1BigQueryDestination", "description": "BigQueryDestination is a wrapper for BigQuery output information." }, "GoogleCloudFinancialservicesV1ExportPredictionResultMetadataRequest": { "id": "GoogleCloudFinancialservicesV1ExportPredictionResultMetadataRequest", "type": "object", "description": "Request for exporting PredictionResult metadata.", "properties": { "structuredMetadataDestination": { "description": "Required. BigQuery output where the metadata will be written.", "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination" } } }, "GoogleCloudFinancialservicesV1ExportBacktestResultMetadataRequest": { "type": "object", "id": "GoogleCloudFinancialservicesV1ExportBacktestResultMetadataRequest", "description": "Request for exporting BacktestResult metadata.", "properties": { "structuredMetadataDestination": { "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination", "description": "Required. BigQuery output where the metadata will be written." } } }, "GoogleCloudFinancialservicesV1ImportRegisteredPartiesRequest": { "type": "object", "id": "GoogleCloudFinancialservicesV1ImportRegisteredPartiesRequest", "description": "Request for adding/removing registered parties from BigQuery tables specified by the customer.", "properties": { "lineOfBusiness": { "type": "string", "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ], "description": "Required. LineOfBusiness for the specified registered parties.", "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ] }, "validateOnly": { "description": "Optional. If the request will not register the parties, just determine what would happen.", "type": "boolean" }, "partyTables": { "type": "array", "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", "items": { "type": "string" } }, "mode": { "enumDescriptions": [ "Default mode.", "Replace parties that are removable in Parties Table with new parties.", "Add new parties to Parties Table." ], "description": "Required. Mode of the request.", "type": "string", "enum": [ "UPDATE_MODE_UNSPECIFIED", "REPLACE", "APPEND" ] } } }, "GoogleCloudFinancialservicesV1BacktestResultPerformanceTarget": { "type": "object", "id": "GoogleCloudFinancialservicesV1BacktestResultPerformanceTarget", "properties": { "partyInvestigationsPerPeriodHint": { "type": "string", "format": "int64", "description": "Optional. A hint on the number of parties from this data that will be investigated per period (monthly). This is used to ensure the model is evaluated at relevant investigation volumes. 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. Either this field or party_count_exceeding_threshold_per_period_hint should be provided. If both are omitted, or both are provided, it will throw an error." }, "partyCountExceedingThresholdPerPeriodHint": { "type": "string", "format": "int64", "description": "Optional. A hint on the number of parties from this data that should score above the threshold for alerting per period (monthly). This is used to ensure the model is evaluated at a relevant alerting volume and can be used for a quick comparison of backtesting for multiple candidate models. Either this field or party_investigations_per_period_hint should be provided. If both are omitted, or both are provided, it will throw an error." } }, "description": "PerformanceTarget gives hints on how to evaluate the performance of a model." }, "Operation": { "type": "object", "properties": { "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "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" }, "metadata": { "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": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "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": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "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." } }, "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call." }, "Location": { "type": "object", "properties": { "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" }, "type": "object" }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location." }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" } }, "description": "A resource that represents a Google Cloud location.", "id": "Location" }, "GoogleCloudFinancialservicesV1ListBacktestResultsResponse": { "id": "GoogleCloudFinancialservicesV1ListBacktestResultsResponse", "description": "Response for retrieving a list of BacktestResults", "properties": { "backtestResults": { "description": "List of BacktestResult resources", "type": "array", "items": { "$ref": "GoogleCloudFinancialservicesV1BacktestResult" } }, "nextPageToken": { "description": "This token should be passed to the next ListBacktestResultsRequest to retrieve the next page of BacktestResults (empty indicates we are done).", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } }, "type": "object" }, "Status": { "type": "object", "id": "Status", "properties": { "message": { "type": "string", "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." }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "type": "array" }, "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." } }, "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)." }, "Interval": { "properties": { "endTime": { "type": "string", "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "format": "google-datetime" }, "startTime": { "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.", "type": "string" } }, "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.", "type": "object", "id": "Interval" }, "GoogleCloudFinancialservicesV1ListDatasetsResponse": { "id": "GoogleCloudFinancialservicesV1ListDatasetsResponse", "properties": { "unreachable": { "description": "Locations that could not be reached.", "items": { "type": "string" }, "type": "array" }, "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" }, "datasets": { "description": "List of Dataset resources", "type": "array", "items": { "$ref": "GoogleCloudFinancialservicesV1Dataset" } } }, "description": "Response for retrieving a list of Datasets", "type": "object" }, "GoogleCloudFinancialservicesV1EngineConfig": { "description": "The EngineConfig resource creates the configuration for training a model.", "properties": { "satisfiesPzi": { "description": "Output only. [Output Only] Reserved for future use.", "type": "boolean", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The timestamp of creation of this resource.", "type": "string" }, "hyperparameterSourceType": { "type": "string", "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" ], "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." ] }, "labels": { "description": "Labels", "type": "object", "additionalProperties": { "type": "string" } }, "performanceTarget": { "$ref": "GoogleCloudFinancialservicesV1EngineConfigPerformanceTarget", "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." }, "engineVersion": { "type": "string", "description": "Required. The resource name of the EngineVersion used in this model tuning. format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`" }, "name": { "type": "string", "readOnly": true, "description": "Output only. The resource name of the EngineConfig. format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`" }, "lineOfBusiness": { "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ], "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ], "type": "string", "readOnly": true, "description": "Output only. The line of business (Retail/Commercial) this engine config is used for. Determined by EngineVersion, cannot be set by user." }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING" ], "readOnly": true, "description": "Output only. State of the EngineConfig (creating, active, deleting, etc.)", "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." ] }, "hyperparameterSource": { "description": "Optional. Configuration of hyperparameters source EngineConfig.", "$ref": "GoogleCloudFinancialservicesV1EngineConfigHyperparameterSource" }, "satisfiesPzs": { "description": "Output only. [Output Only] Reserved for future use.", "readOnly": true, "type": "boolean" }, "updateTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The timestamp of the most recent update of this resource." }, "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" } }, "id": "GoogleCloudFinancialservicesV1EngineConfig", "type": "object" }, "CancelOperationRequest": { "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "properties": {}, "type": "object" }, "TimeZone": { "type": "object", "id": "TimeZone", "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", "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\"." } } }, "GoogleCloudFinancialservicesV1EngineConfigPerformanceTarget": { "id": "GoogleCloudFinancialservicesV1EngineConfigPerformanceTarget", "description": "PerformanceTarget gives hints on how to evaluate the performance of a model.", "type": "object", "properties": { "partyInvestigationsPerPeriodHint": { "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.", "type": "string" } } }, "GoogleCloudFinancialservicesV1PredictionResult": { "properties": { "endTime": { "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.", "type": "string", "format": "google-datetime" }, "satisfiesPzs": { "type": "boolean", "description": "Output only. [Output Only] Reserved for future use.", "readOnly": true }, "outputs": { "$ref": "GoogleCloudFinancialservicesV1PredictionResultOutputs", "description": "Required. Where to write the output of the predictions." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The timestamp of creation of this resource." }, "name": { "description": "Output only. The resource name of the PredictionResult. format: `/projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}`", "readOnly": true, "type": "string" }, "predictionPeriods": { "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.", "type": "integer", "format": "int32" }, "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" }, "state": { "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." ], "type": "string", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING" ], "description": "Output only. State of the PredictionResult (creating, active, deleting, etc.)" }, "lineOfBusiness": { "description": "Output only. The line of business (Retail/Commercial) this prediction is for. Determined by Model, cannot be set by user.", "readOnly": true, "type": "string", "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ], "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ] }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels", "type": "object" }, "updateTime": { "format": "google-datetime", "description": "Output only. The timestamp of the most recent update of this resource.", "type": "string", "readOnly": true }, "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}`" }, "satisfiesPzi": { "description": "Output only. [Output Only] Reserved for future use.", "type": "boolean", "readOnly": true } }, "type": "object", "id": "GoogleCloudFinancialservicesV1PredictionResult", "description": "PredictionResult is the result of using a model to create predictions." }, "GoogleCloudFinancialservicesV1Instance": { "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.", "type": "object", "properties": { "satisfiesPzi": { "type": "boolean", "readOnly": true, "description": "Output only. [Output Only] Reserved for future use." }, "partyRegistrationSharingHostInstance": { "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.", "type": "string" }, "createTime": { "type": "string", "readOnly": true, "description": "Output only. Timestamp when the Instance was created. Assigned by the server.", "format": "google-datetime" }, "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" } }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels", "type": "object" }, "kmsKey": { "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.", "type": "string" }, "name": { "description": "Output only. The full path to the Instance resource in this API. format: `projects/{project}/locations/{location}/instances/{instance}`", "type": "string", "readOnly": true }, "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. [Output Only] Reserved for future use." }, "state": { "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" ], "type": "string", "description": "Output only. State of the instance. Assigned by the server.", "readOnly": true }, "updateTime": { "description": "Output only. Timestamp when the Instance was last updated. Assigned by the server.", "type": "string", "readOnly": true, "format": "google-datetime" } }, "id": "GoogleCloudFinancialservicesV1Instance" }, "ListLocationsResponse": { "type": "object", "id": "ListLocationsResponse", "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" } } }, "GoogleCloudFinancialservicesV1ExportRegisteredPartiesRequest": { "properties": { "lineOfBusiness": { "enumDescriptions": [ "An unspecified LineOfBusiness. Do not use.", "Commercial LineOfBusiness.", "Retail LineOfBusiness." ], "enum": [ "LINE_OF_BUSINESS_UNSPECIFIED", "COMMERCIAL", "RETAIL" ], "type": "string", "description": "Required. LineOfBusiness to get RegisteredParties from." }, "dataset": { "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination", "description": "Required. The location to output the RegisteredParties." } }, "id": "GoogleCloudFinancialservicesV1ExportRegisteredPartiesRequest", "description": "Request to export a list of currently registered parties.", "type": "object" }, "GoogleCloudFinancialservicesV1ListEngineConfigsResponse": { "description": "Response for retrieving a list of EngineConfigs", "id": "GoogleCloudFinancialservicesV1ListEngineConfigsResponse", "type": "object", "properties": { "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" }, "engineConfigs": { "items": { "$ref": "GoogleCloudFinancialservicesV1EngineConfig" }, "type": "array", "description": "List of EngineConfig resources" }, "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Locations that could not be reached." } } }, "GoogleCloudFinancialservicesV1ImportRegisteredPartiesResponse": { "description": "Response for adding/removing registered parties from BigQuery tables.", "id": "GoogleCloudFinancialservicesV1ImportRegisteredPartiesResponse", "properties": { "partiesAdded": { "description": "Number of parties added by this operation.", "type": "string", "format": "int64" }, "partiesTotal": { "type": "string", "format": "int64", "description": "Total number of parties that are registered in this instance, after the update operation was completed." }, "partiesFailedToRemove": { "type": "string", "format": "int64", "description": "Number of parties that failed to be removed by this operation." }, "partiesDowntiered": { "format": "int64", "description": "Total number of parties that are downtiered in this instance", "type": "string" }, "partiesUptiered": { "format": "int64", "type": "string" }, "partiesFailedToDowntier": { "type": "string", "format": "int64", "description": "Number of parties that failed to be downtiered" }, "partiesRemoved": { "format": "int64", "type": "string", "description": "Number of parties removed by this operation." } }, "type": "object" }, "GoogleCloudFinancialservicesV1ListEngineVersionsResponse": { "type": "object", "description": "The response to a list call containing the list of engine versions.", "id": "GoogleCloudFinancialservicesV1ListEngineVersionsResponse", "properties": { "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." }, "engineVersions": { "description": "List of EngineVersion resources", "items": { "$ref": "GoogleCloudFinancialservicesV1EngineVersion" }, "type": "array" } } }, "GoogleCloudFinancialservicesV1EngineConfigHyperparameterSource": { "type": "object", "properties": { "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}`", "type": "string", "readOnly": true }, "sourceEngineConfig": { "description": "Required. The resource name of the source EngineConfig whose outputs are used. Format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`", "type": "string" } }, "description": "Parameters for bootstrapping an Engine Config with the results of another one.", "id": "GoogleCloudFinancialservicesV1EngineConfigHyperparameterSource" }, "GoogleCloudFinancialservicesV1ExportModelMetadataRequest": { "description": "Request for exporting Model metadata.", "id": "GoogleCloudFinancialservicesV1ExportModelMetadataRequest", "type": "object", "properties": { "structuredMetadataDestination": { "description": "Required. BigQuery output where the metadata will be written.", "$ref": "GoogleCloudFinancialservicesV1BigQueryDestination" } } } }, "description": "", "protocol": "rest", "basePath": "", "baseUrl": "https://financialservices.googleapis.com/", "version": "v1" }