Google Cloud Financial Services V1 Client - Class BacktestResult (0.2.1)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`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`	`Google\Protobuf\Timestamp` Output only. The timestamp of creation of this resource.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The timestamp of the most recent update of this resource.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` 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}

Returns
Type	Description
`string`

setName

Output only. The resource name of the BacktestResult.

format: /projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The timestamp of creation of this resource.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp of creation of this resource.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The timestamp of the most recent update of this resource.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp of the most recent update of this resource.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getLabels

Labels

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Labels

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getState

Output only. State of the BacktestResult (creating, active, deleting, etc.)

Returns
Type	Description
`int`	Enum of type State.

setState

Output only. State of the BacktestResult (creating, active, deleting, etc.)

Parameter
Name	Description
`var`	`int` Enum of type State.

Returns
Type	Description
`$this`

getDataset

Required. The resource name of the Dataset to backtest on Format: /projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}

Returns
Type	Description
`string`

setDataset

Required. The resource name of the Dataset to backtest on Format: /projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getModel

Required. The resource name of the Model to use or to backtest.

Format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}

Returns
Type	Description
`string`

setModel

Required. The resource name of the Model to use or to backtest.

Format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasEndTime

clearEndTime

setEndTime

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$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.

Returns
Type	Description
`int`

setBacktestPeriods