Reference documentation and code samples for the Google Cloud Financial Services V1 Client class BacktestResult.
BacktestResult is created to test the performance of a model on a dataset.
Generated from protobuf message google.cloud.financialservices.v1.BacktestResult
Namespace
Google \ Cloud \ FinancialServices \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name of the BacktestResult. format: /projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}
↳ create_time
↳ update_time
↳ labels
↳ state
int
Output only. State of the BacktestResult (creating, active, deleting, etc.)
↳ dataset
string
Required. The resource name of the Dataset to backtest on Format: /projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}
↳ model
string
Required. The resource name of the Model to use or to backtest. Format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}
↳ end_time
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.
↳ backtest_periods
int
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.
↳ performance_target
BacktestResult\PerformanceTarget
Required. PerformanceTarget gives information on how the test will be evaluated.
↳ line_of_business
int
Output only. The line of business (Retail/Commercial) this backtest is for. Determined by Model, cannot be set by user.
getName
Output only. The resource name of the BacktestResult.
format: /projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}
string
setName
Output only. The resource name of the BacktestResult.
format: /projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}
var
string
$this
getCreateTime
Output only. The timestamp of creation of this resource.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp of creation of this resource.
$this
getUpdateTime
Output only. The timestamp of the most recent update of this resource.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp of the most recent update of this resource.
$this
getLabels
Labels
setLabels
Labels
$this
getState
Output only. State of the BacktestResult (creating, active, deleting, etc.)
int
setState
Output only. State of the BacktestResult (creating, active, deleting, etc.)
var
int
$this
getDataset
Required. The resource name of the Dataset to backtest on
Format: /projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}
string
setDataset
Required. The resource name of the Dataset to backtest on
Format: /projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}
var
string
$this
getModel
Required. The resource name of the Model to use or to backtest.
Format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}
string
setModel
Required. The resource name of the Model to use or to backtest.
Format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}
var
string
$this
getEndTime
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.
hasEndTime
clearEndTime
setEndTime
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.
$this
getBacktestPeriods
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.
int
setBacktestPeriods
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.
var
int
$this
getPerformanceTarget
Required. PerformanceTarget gives information on how the test will be evaluated.
hasPerformanceTarget
clearPerformanceTarget
setPerformanceTarget
Required. PerformanceTarget gives information on how the test will be evaluated.
$this
getLineOfBusiness
Output only. The line of business (Retail/Commercial) this backtest is for.
Determined by Model, cannot be set by user.
int
setLineOfBusiness
Output only. The line of business (Retail/Commercial) this backtest is for.
Determined by Model, cannot be set by user.
var
int
$this
