# frozen_string_literal: true

# 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
#
#     https://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.

# Auto-generated by gapic-generator-ruby. DO NOT EDIT!


module Google
  module Cloud
    module FinancialServices
      module V1
        # BacktestResult is created to test the performance of a model on a dataset.
        # @!attribute [r] name
        #   @return [::String]
        #     Output only. The resource name of the BacktestResult.
        #     format:
        #     `/projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}`
        # @!attribute [r] create_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. The timestamp of creation of this resource.
        # @!attribute [r] update_time
        #   @return [::Google::Protobuf::Timestamp]
        #     Output only. The timestamp of the most recent update of this resource.
        # @!attribute [rw] labels
        #   @return [::Google::Protobuf::Map{::String => ::String}]
        #     Labels
        # @!attribute [r] state
        #   @return [::Google::Cloud::FinancialServices::V1::BacktestResult::State]
        #     Output only. State of the BacktestResult (creating, active, deleting, etc.)
        # @!attribute [rw] dataset
        #   @return [::String]
        #     Required. The resource name of the Dataset to backtest on
        #     Format:
        #     `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
        # @!attribute [rw] model
        #   @return [::String]
        #     Required. The resource name of the Model to use or to backtest.
        #     Format:
        #     `/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}`
        # @!attribute [rw] end_time
        #   @return [::Google::Protobuf::Timestamp]
        #     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.
        # @!attribute [rw] backtest_periods
        #   @return [::Integer]
        #     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.
        # @!attribute [rw] performance_target
        #   @return [::Google::Cloud::FinancialServices::V1::BacktestResult::PerformanceTarget]
        #     Required. PerformanceTarget gives information on how the test will be
        #     evaluated.
        # @!attribute [r] line_of_business
        #   @return [::Google::Cloud::FinancialServices::V1::LineOfBusiness]
        #     Output only. The line of business (Retail/Commercial) this backtest is for.
        #     Determined by Model, cannot be set by user.
        class BacktestResult
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # PerformanceTarget gives hints on how to evaluate the performance of a
          # model.
          # @!attribute [rw] party_investigations_per_period_hint
          #   @return [::Integer]
          #     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.
          class PerformanceTarget
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # @!attribute [rw] key
          #   @return [::String]
          # @!attribute [rw] value
          #   @return [::String]
          class LabelsEntry
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # The possible states of a resource.
          module 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
          end
        end

        # Request for retrieving a paginated list of BacktestResult resources that
        # meet the specified criteria.
        # @!attribute [rw] parent
        #   @return [::String]
        #     Required. The parent of the BacktestResult is the Instance.
        # @!attribute [rw] page_size
        #   @return [::Integer]
        #     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.
        # @!attribute [rw] page_token
        #   @return [::String]
        #     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.
        # @!attribute [rw] filter
        #   @return [::String]
        #     Specify a filter to narrow search results.
        # @!attribute [rw] order_by
        #   @return [::String]
        #     Specify a field to use for ordering.
        class ListBacktestResultsRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Response for retrieving a list of BacktestResults
        # @!attribute [rw] backtest_results
        #   @return [::Array<::Google::Cloud::FinancialServices::V1::BacktestResult>]
        #     List of BacktestResult resources
        # @!attribute [rw] next_page_token
        #   @return [::String]
        #     This token should be passed to the next ListBacktestResultsRequest to
        #     retrieve the next page of BacktestResults (empty indicates we are
        #     done).
        # @!attribute [rw] unreachable
        #   @return [::Array<::String>]
        #     Locations that could not be reached.
        class ListBacktestResultsResponse
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request for retrieving a specific BacktestResult resource.
        # @!attribute [rw] name
        #   @return [::String]
        #     Required. The resource name of the BacktestResult
        class GetBacktestResultRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request for creating a BacktestResult resource.
        # @!attribute [rw] parent
        #   @return [::String]
        #     Required. The parent of the BacktestResult is the Instance.
        # @!attribute [rw] backtest_result_id
        #   @return [::String]
        #     Required. The resource id of the BacktestResult
        # @!attribute [rw] backtest_result
        #   @return [::Google::Cloud::FinancialServices::V1::BacktestResult]
        #     Required. The BacktestResult that will be created.
        # @!attribute [rw] request_id
        #   @return [::String]
        #     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).
        class CreateBacktestResultRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request for updating a BacktestResult
        # @!attribute [rw] update_mask
        #   @return [::Google::Protobuf::FieldMask]
        #     Optional. Field mask is used to specify the fields to be overwritten in the
        #     BacktestResult resource by the update.
        #     The fields specified in the update_mask are relative to the resource, not
        #     the full request. A field will be overwritten if it is in the mask. If the
        #     user does not provide a mask then all fields will be overwritten.
        # @!attribute [rw] backtest_result
        #   @return [::Google::Cloud::FinancialServices::V1::BacktestResult]
        #     Required. The new value of the BacktestResult fields that will be updated
        #     according to the update_mask.
        # @!attribute [rw] request_id
        #   @return [::String]
        #     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).
        class UpdateBacktestResultRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request for deleting a BacktestResult.
        # @!attribute [rw] name
        #   @return [::String]
        #     Required. The resource name of the BacktestResult.
        # @!attribute [rw] request_id
        #   @return [::String]
        #     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).
        class DeleteBacktestResultRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Request for exporting BacktestResult metadata.
        # @!attribute [rw] backtest_result
        #   @return [::String]
        #     Required. The resource name of the BacktestResult.
        # @!attribute [rw] structured_metadata_destination
        #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
        #     Required. BigQuery output where the metadata will be written.
        class ExportBacktestResultMetadataRequest
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # Response for exporting BacktestResult metadata.
        class ExportBacktestResultMetadataResponse
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end
      end
    end
  end
end
