Class BacktestResult (0.1.0) 

public final class BacktestResult extends GeneratedMessageV3 implements BacktestResultOrBuilder

BacktestResult is created to test the performance of a model on a dataset.

Protobuf type google.cloud.financialservices.v1.BacktestResult

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BacktestResult

Static Fields

BACKTEST_PERIODS_FIELD_NUMBER

public static final int BACKTEST_PERIODS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DATASET_FIELD_NUMBER

public static final int DATASET_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LINE_OF_BUSINESS_FIELD_NUMBER

public static final int LINE_OF_BUSINESS_FIELD_NUMBER
Field Value
Type Description
int

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PERFORMANCE_TARGET_FIELD_NUMBER

public static final int PERFORMANCE_TARGET_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BacktestResult getDefaultInstance()
Returns
Type Description
BacktestResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BacktestResult.Builder newBuilder()
Returns
Type Description
BacktestResult.Builder

newBuilder(BacktestResult prototype)

public static BacktestResult.Builder newBuilder(BacktestResult prototype)
Parameter
Name Description
prototype BacktestResult
Returns
Type Description
BacktestResult.Builder

parseDelimitedFrom(InputStream input)

public static BacktestResult parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BacktestResult
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BacktestResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BacktestResult
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BacktestResult parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BacktestResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BacktestResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BacktestResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BacktestResult parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BacktestResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BacktestResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BacktestResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BacktestResult parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BacktestResult
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BacktestResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BacktestResult
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BacktestResult parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BacktestResult
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BacktestResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BacktestResult
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BacktestResult parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BacktestResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BacktestResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BacktestResult
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BacktestResult> parser()
Returns
Type Description
Parser<BacktestResult>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBacktestPeriods()

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

getDefaultInstanceForType()

public BacktestResult getDefaultInstanceForType()
Returns
Type Description
BacktestResult

getEndTime()

public 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 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public 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 String getLabelsOrThrow(String key)

Labels

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getLineOfBusiness()

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

getParserForType()

public Parser<BacktestResult> getParserForType()
Returns
Type Description
Parser<BacktestResult>
Overrides

getPerformanceTarget()

public 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 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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BacktestResult.Builder newBuilderForType()
Returns
Type Description
BacktestResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BacktestResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BacktestResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BacktestResult.Builder toBuilder()
Returns
Type Description
BacktestResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException