public final class EngineConfig extends GeneratedMessageV3 implements EngineConfigOrBuilder
The EngineConfig resource creates the configuration for training a model.
Protobuf type google.cloud.financialservices.v1.EngineConfig
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 |
|
ENGINE_VERSION_FIELD_NUMBER
public static final int ENGINE_VERSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
HYPERPARAMETER_SOURCE_FIELD_NUMBER
public static final int HYPERPARAMETER_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
HYPERPARAMETER_SOURCE_TYPE_FIELD_NUMBER
public static final int HYPERPARAMETER_SOURCE_TYPE_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 |
|
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 |
|
TUNING_FIELD_NUMBER
public static final int TUNING_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 EngineConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static EngineConfig.Builder newBuilder()
newBuilder(EngineConfig prototype)
public static EngineConfig.Builder newBuilder(EngineConfig prototype)
public static EngineConfig parseDelimitedFrom(InputStream input)
public static EngineConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static EngineConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EngineConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static EngineConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EngineConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EngineConfig parseFrom(CodedInputStream input)
public static EngineConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static EngineConfig parseFrom(InputStream input)
public static EngineConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static EngineConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EngineConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<EngineConfig> 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 EngineConfig getDefaultInstanceForType()
getEngineVersion()
public String getEngineVersion()
Required. The resource name of the EngineVersion used in this model tuning.
format:
/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}
string engine_version = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The engineVersion.
|
getEngineVersionBytes()
public ByteString getEngineVersionBytes()
Required. The resource name of the EngineVersion used in this model tuning.
format:
/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}
string engine_version = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for engineVersion.
|
getHyperparameterSource()
public EngineConfig.HyperparameterSource getHyperparameterSource()
Optional. Configuration of hyperparameters source EngineConfig.
.google.cloud.financialservices.v1.EngineConfig.HyperparameterSource hyperparameter_source = 16 [(.google.api.field_behavior) = OPTIONAL];
getHyperparameterSourceOrBuilder()
public EngineConfig.HyperparameterSourceOrBuilder getHyperparameterSourceOrBuilder()
Optional. Configuration of hyperparameters source EngineConfig.
.google.cloud.financialservices.v1.EngineConfig.HyperparameterSource hyperparameter_source = 16 [(.google.api.field_behavior) = OPTIONAL];
getHyperparameterSourceType()
public EngineConfig.HyperparameterSourceType getHyperparameterSourceType()
Optional. The origin of hyperparameters for the created EngineConfig. The
default is TUNING. In this case, the hyperparameters are selected as a
result of a
tuning run.
.google.cloud.financialservices.v1.EngineConfig.HyperparameterSourceType hyperparameter_source_type = 15 [(.google.api.field_behavior) = OPTIONAL];
getHyperparameterSourceTypeValue()
public int getHyperparameterSourceTypeValue()
Optional. The origin of hyperparameters for the created EngineConfig. The
default is TUNING. In this case, the hyperparameters are selected as a
result of a
tuning run.
.google.cloud.financialservices.v1.EngineConfig.HyperparameterSourceType hyperparameter_source_type = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for hyperparameterSourceType.
|
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 engine config is
used for. Determined by EngineVersion, 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 engine config is
used for. Determined by EngineVersion, 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 EngineConfig.
format:
/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}
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 EngineConfig.
format:
/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<EngineConfig> getParserForType()
Overrides
public EngineConfig.PerformanceTarget getPerformanceTarget()
Optional. PerformanceTarget gives information on how the tuning and
training will be evaluated. This field is required if
hyperparameter_source.type is not INHERITED, and output-only otherwise.
.google.cloud.financialservices.v1.EngineConfig.PerformanceTarget performance_target = 11 [(.google.api.field_behavior) = OPTIONAL];
public EngineConfig.PerformanceTargetOrBuilder getPerformanceTargetOrBuilder()
Optional. PerformanceTarget gives information on how the tuning and
training will be evaluated. This field is required if
hyperparameter_source.type is not INHERITED, and output-only otherwise.
.google.cloud.financialservices.v1.EngineConfig.PerformanceTarget performance_target = 11 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getState()
public EngineConfig.State getState()
Output only. State of the EngineConfig (creating, active, deleting, etc.)
.google.cloud.financialservices.v1.EngineConfig.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. State of the EngineConfig (creating, active, deleting, etc.)
.google.cloud.financialservices.v1.EngineConfig.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
getTuning()
public EngineConfig.Tuning getTuning()
Optional. Configuration for tuning in creation of the EngineConfig.
This field is required if hyperparameter_source.type is not INHERITED,
and output-only otherwise.
.google.cloud.financialservices.v1.EngineConfig.Tuning tuning = 7 [(.google.api.field_behavior) = OPTIONAL];
getTuningOrBuilder()
public EngineConfig.TuningOrBuilder getTuningOrBuilder()
Optional. Configuration for tuning in creation of the EngineConfig.
This field is required if hyperparameter_source.type is not INHERITED,
and output-only otherwise.
.google.cloud.financialservices.v1.EngineConfig.Tuning tuning = 7 [(.google.api.field_behavior) = OPTIONAL];
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.
|
hasHyperparameterSource()
public boolean hasHyperparameterSource()
Optional. Configuration of hyperparameters source EngineConfig.
.google.cloud.financialservices.v1.EngineConfig.HyperparameterSource hyperparameter_source = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the hyperparameterSource field is set.
|
public boolean hasPerformanceTarget()
Optional. PerformanceTarget gives information on how the tuning and
training will be evaluated. This field is required if
hyperparameter_source.type is not INHERITED, and output-only otherwise.
.google.cloud.financialservices.v1.EngineConfig.PerformanceTarget performance_target = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the performanceTarget field is set.
|
hasTuning()
public boolean hasTuning()
Optional. Configuration for tuning in creation of the EngineConfig.
This field is required if hyperparameter_source.type is not INHERITED,
and output-only otherwise.
.google.cloud.financialservices.v1.EngineConfig.Tuning tuning = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the tuning 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 EngineConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected EngineConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public EngineConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
