// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package google.cloud.financialservices.v1;

import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/financialservices/v1/bigquery_destination.proto";
import "google/cloud/financialservices/v1/line_of_business.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";

option csharp_namespace = "Google.Cloud.FinancialServices.V1";
option go_package = "cloud.google.com/go/financialservices/apiv1/financialservicespb;financialservicespb";
option java_multiple_files = true;
option java_outer_classname = "ModelProto";
option java_package = "com.google.cloud.financialservices.v1";
option php_namespace = "Google\\Cloud\\FinancialServices\\V1";
option ruby_package = "Google::Cloud::FinancialServices::V1";

// Model represents a trained model.
message Model {
  option (google.api.resource) = {
    type: "financialservices.googleapis.com/Model"
    pattern: "projects/{project_num}/locations/{location}/instances/{instance}/models/{model}"
  };

  // The possible states of a resource.
  enum State {
    // State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0;

    // The resource has not finished being created.
    CREATING = 1;

    // The resource is active/ready to be used.
    ACTIVE = 2;

    // The resource is in the process of being updated.
    UPDATING = 3;

    // The resource is in the process of being deleted.
    DELETING = 4;
  }

  // Output only. The resource name of the Model.
  // format:
  // `/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}`
  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The timestamp of creation of this resource.
  google.protobuf.Timestamp create_time = 2
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The timestamp of the most recent update of this resource.
  google.protobuf.Timestamp update_time = 3
      [(google.api.field_behavior) = OUTPUT_ONLY];

  // Labels
  map<string, string> labels = 4;

  // Output only. State of the model (creating, active, deleting, etc.)
  State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY];

  // Output only. The EngineVersion used in training this model.  This is output
  // only, and is determined from the EngineConfig used.
  string engine_version = 6 [
    (google.api.field_behavior) = OUTPUT_ONLY,
    (google.api.resource_reference) = {
      type: "financialservices.googleapis.com/EngineVersion"
    }
  ];

  // Required. The resource name of the EngineConfig the model training will be
  // based on. Format:
  // `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}`
  string engine_config = 7 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "financialservices.googleapis.com/EngineConfig"
    }
  ];

  // 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}`
  string primary_dataset = 8 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "financialservices.googleapis.com/Dataset"
    }
  ];

  // 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.
  google.protobuf.Timestamp end_time = 10
      [(google.api.field_behavior) = REQUIRED];

  // Output only. The line of business (Retail/Commercial) this model is used
  // for. Determined by EngineConfig, cannot be set by user.
  LineOfBusiness line_of_business = 12
      [(google.api.field_behavior) = OUTPUT_ONLY];
}

// Request for retrieving a paginated list of Model resources that meet the
// specified criteria.
message ListModelsRequest {
  // Required. The parent of the Model is the Instance.
  string parent = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "financialservices.googleapis.com/Instance"
    }
  ];

  // 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.
  int32 page_size = 2;

  // 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.
  string page_token = 3;

  // Specify a filter to narrow search results.
  string filter = 4;

  // Specify a field to use for ordering.
  string order_by = 5;
}

// Response for retrieving a list of Models
message ListModelsResponse {
  // List of Model resources
  repeated Model models = 1;

  // This token should be passed to the next ListModelsRequest to
  // retrieve the next page of Models (empty indicicates we are done).
  string next_page_token = 2;

  // Locations that could not be reached.
  repeated string unreachable = 3;
}

// Request for retrieving a specific Model resource.
message GetModelRequest {
  // Required. The resource name of the Model
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "financialservices.googleapis.com/Model"
    }
  ];
}

// Request for creating a Model resource.
message CreateModelRequest {
  // Required. The parent of the Model is the Instance.
  string parent = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "financialservices.googleapis.com/Instance"
    }
  ];

  // Required. The resource id of the Model
  string model_id = 2 [(google.api.field_behavior) = REQUIRED];

  // Required. The Model that will be created.
  Model model = 3 [(google.api.field_behavior) = REQUIRED];

  // 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).
  string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
}

// Request for updating a Model
message UpdateModelRequest {
  // 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.
  google.protobuf.FieldMask update_mask = 1
      [(google.api.field_behavior) = OPTIONAL];

  // Required. The new value of the Model fields that will be updated according
  // to the update_mask.
  Model model = 2 [(google.api.field_behavior) = REQUIRED];

  // 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).
  string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
}

// Request for deleting a Model.
message DeleteModelRequest {
  // Required. The resource name of the Model.
  string name = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "financialservices.googleapis.com/Model"
    }
  ];

  // Optional. An optional request ID to identify requests. Specify a unique
  // request ID so that if you must retry your request, the server will know to
  // ignore the request if it has already been completed. The server will
  // guarantee that for at least 60 minutes 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).
  string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
}

// Request for exporting Model metadata.
message ExportModelMetadataRequest {
  // Required. The resource name of the Model.
  string model = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference) = {
      type: "financialservices.googleapis.com/Model"
    }
  ];

  // Required. BigQuery output where the metadata will be written.
  BigQueryDestination structured_metadata_destination = 2
      [(google.api.field_behavior) = REQUIRED];
}

// Response for exporting Model metadata.
message ExportModelMetadataResponse {}
