Interface ModelOrBuilder (0.1.0)

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

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

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 training. End_time should be no later than the end of the date_range of the dataset.

.google.protobuf.Timestamp end_time = 10 [(.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 training. End_time should be no later than the end of the date_range of the dataset.

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

Returns
Type Description
TimestampOrBuilder

getEngineConfig()

public abstract String getEngineConfig()

Required. The resource name of the EngineConfig the model training will be based on. Format: "/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}"

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

Returns
Type Description
String

The engineConfig.

getEngineConfigBytes()

public abstract ByteString getEngineConfigBytes()

Required. The resource name of the EngineConfig the model training will be based on. Format: "/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}"

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

Returns
Type Description
ByteString

The bytes for engineConfig.

getEngineVersion()

public abstract String getEngineVersion()

Output only. The EngineVersion used in training this model. This is output only, and is determined from the EngineConfig used.

string engine_version = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The engineVersion.

getEngineVersionBytes()

public abstract ByteString getEngineVersionBytes()

Output only. The EngineVersion used in training this model. This is output only, and is determined from the EngineConfig used.

string engine_version = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for engineVersion.

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 model is used for. Determined by EngineConfig, 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 model is used for. Determined by EngineConfig, 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.

getName()

public abstract String getName()

Output only. The resource name of the Model. format: "/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}"

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 Model. format: "/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}"

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

Returns
Type Description
ByteString

The bytes for name.

getPrimaryDataset()

public abstract String getPrimaryDataset()

Required. The resource name of the Primary Dataset used in this model training. For information about how primary and auxiliary datasets are used, refer to the engine version's documentation. Format: "/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}"

string primary_dataset = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The primaryDataset.

getPrimaryDatasetBytes()

public abstract ByteString getPrimaryDatasetBytes()

Required. The resource name of the Primary Dataset used in this model training. For information about how primary and auxiliary datasets are used, refer to the engine version's documentation. Format: "/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}"

string primary_dataset = 8 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for primaryDataset.

getState()

public abstract Model.State getState()

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

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

Returns
Type Description
Model.State

The state.

getStateValue()

public abstract int getStateValue()

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

.google.cloud.financialservices.v1.Model.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 training. End_time should be no later than the end of the date_range of the dataset.

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

Returns
Type Description
boolean

Whether the endTime 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.