public final class Model extends GeneratedMessageV3 implements ModelOrBuilder
Model represents a trained model.
Protobuf type google.cloud.financialservices.v1.Model
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENGINE_CONFIG_FIELD_NUMBER
public static final int ENGINE_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENGINE_VERSION_FIELD_NUMBER
public static final int ENGINE_VERSION_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 |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PRIMARY_DATASET_FIELD_NUMBER
public static final int PRIMARY_DATASET_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 Model getDefaultInstance()
| Returns |
| Type |
Description |
Model |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Model.Builder newBuilder()
newBuilder(Model prototype)
public static Model.Builder newBuilder(Model prototype)
| Parameter |
| Name |
Description |
prototype |
Model
|
public static Model parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Model |
|
public static Model parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Model |
|
parseFrom(byte[] data)
public static Model parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Model |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Model parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Model |
|
parseFrom(ByteString data)
public static Model parseFrom(ByteString data)
| Returns |
| Type |
Description |
Model |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Model parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Model |
|
public static Model parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Model |
|
public static Model parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Model |
|
public static Model parseFrom(InputStream input)
| Returns |
| Type |
Description |
Model |
|
public static Model parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Model |
|
parseFrom(ByteBuffer data)
public static Model parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Model |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Model parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Model |
|
parser()
public static Parser<Model> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Labels
map<string, string> labels = 4;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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];
getDefaultInstanceForType()
public Model getDefaultInstanceForType()
| Returns |
| Type |
Description |
Model |
|
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 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 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];
getEngineConfig()
public 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 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 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 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 Map<String,String> getLabels()
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;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Labels
map<string, string> labels = 4;
| 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 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];
getLineOfBusinessValue()
public 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()
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 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.
|
getParserForType()
public Parser<Model> getParserForType()
Overrides
getPrimaryDataset()
public 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 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getState()
public 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];
getStateValue()
public 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 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];
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 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 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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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()
Overrides
newBuilderForType()
public Model.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Model.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Model.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
