Interface BacktestResultOrBuilder (0.17.0) 

public interface BacktestResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

getBacktestPeriods()

public abstract int 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.

int32 backtest_periods = 10;

Returns
Type Description
int

The backtestPeriods.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The timestamp of creation of this resource.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp of creation of this resource.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDataset()

public abstract String getDataset()

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

string dataset = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The dataset.

getDatasetBytes()

public abstract ByteString getDatasetBytes()

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

string dataset = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for dataset.

getEndTime()

public abstract Timestamp 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.

.google.protobuf.Timestamp end_time = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public abstract TimestampOrBuilder getEndTimeOrBuilder()

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.

.google.protobuf.Timestamp end_time = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TimestampOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getLineOfBusiness()

public abstract LineOfBusiness getLineOfBusiness()

Output only. The line of business (Retail/Commercial) this backtest is for. Determined by Model, cannot be set by user.

.google.cloud.financialservices.v1.LineOfBusiness line_of_business = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LineOfBusiness

The lineOfBusiness.

getLineOfBusinessValue()

public abstract int getLineOfBusinessValue()

Output only. The line of business (Retail/Commercial) this backtest is for. Determined by Model, cannot be set by user.

.google.cloud.financialservices.v1.LineOfBusiness line_of_business = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for lineOfBusiness.

getModel()

public abstract String getModel()

Required. The resource name of the Model to use or to backtest. Format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}

string model = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The model.

getModelBytes()

public abstract ByteString getModelBytes()

Required. The resource name of the Model to use or to backtest. Format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}

string model = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for model.

getName()

public abstract String getName()

Output only. The resource name of the BacktestResult. format: /projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The resource name of the BacktestResult. format: /projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getPerformanceTarget()

public abstract BacktestResult.PerformanceTarget getPerformanceTarget()

Required. PerformanceTarget gives information on how the test will be evaluated.

.google.cloud.financialservices.v1.BacktestResult.PerformanceTarget performance_target = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BacktestResult.PerformanceTarget

The performanceTarget.

getPerformanceTargetOrBuilder()

public abstract BacktestResult.PerformanceTargetOrBuilder getPerformanceTargetOrBuilder()

Required. PerformanceTarget gives information on how the test will be evaluated.

.google.cloud.financialservices.v1.BacktestResult.PerformanceTarget performance_target = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BacktestResult.PerformanceTargetOrBuilder

getState()

public abstract BacktestResult.State getState()

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

.google.cloud.financialservices.v1.BacktestResult.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BacktestResult.State

The state.

getStateValue()

public abstract int getStateValue()

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

.google.cloud.financialservices.v1.BacktestResult.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public abstract Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The timestamp of creation of this resource.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasEndTime()

public abstract boolean hasEndTime()

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.

.google.protobuf.Timestamp end_time = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the endTime field is set.

hasPerformanceTarget()

public abstract boolean hasPerformanceTarget()

Required. PerformanceTarget gives information on how the test will be evaluated.

.google.cloud.financialservices.v1.BacktestResult.PerformanceTarget performance_target = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the performanceTarget field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.