public final class CustomTuningModel extends GeneratedMessageV3 implements CustomTuningModelOrBuilder
Metadata that describes a custom tuned model.
Protobuf type google.cloud.discoveryengine.v1.CustomTuningModel
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 |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
METRICS_FIELD_NUMBER
public static final int METRICS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MODEL_STATE_FIELD_NUMBER
public static final int MODEL_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MODEL_VERSION_FIELD_NUMBER
public static final int MODEL_VERSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TRAINING_START_TIME_FIELD_NUMBER
public static final int TRAINING_START_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CustomTuningModel getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CustomTuningModel.Builder newBuilder()
newBuilder(CustomTuningModel prototype)
public static CustomTuningModel.Builder newBuilder(CustomTuningModel prototype)
public static CustomTuningModel parseDelimitedFrom(InputStream input)
public static CustomTuningModel parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CustomTuningModel parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CustomTuningModel parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CustomTuningModel parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomTuningModel parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomTuningModel parseFrom(CodedInputStream input)
public static CustomTuningModel parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CustomTuningModel parseFrom(InputStream input)
public static CustomTuningModel parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CustomTuningModel parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CustomTuningModel parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CustomTuningModel> parser()
Methods
containsMetrics(String key)
public boolean containsMetrics(String key)
The metrics of the trained model.
map<string, double> metrics = 7;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCreateTime() (deprecated)
public Timestamp getCreateTime()
Deprecated. google.cloud.discoveryengine.v1.CustomTuningModel.create_time is deprecated. See
google/cloud/discoveryengine/v1/custom_tuning_model.proto;l=88
Deprecated: timestamp the Model was created at.
.google.protobuf.Timestamp create_time = 5 [deprecated = true];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder() (deprecated)
public TimestampOrBuilder getCreateTimeOrBuilder()
Deprecated: timestamp the Model was created at.
.google.protobuf.Timestamp create_time = 5 [deprecated = true];
getDefaultInstanceForType()
public CustomTuningModel getDefaultInstanceForType()
getDisplayName()
public String getDisplayName()
The display name of the model.
string display_name = 2;
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
The display name of the model.
string display_name = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getMetrics() (deprecated)
public Map<String,Double> getMetrics()
getMetricsCount()
public int getMetricsCount()
The metrics of the trained model.
map<string, double> metrics = 7;
| Returns |
| Type |
Description |
int |
|
getMetricsMap()
public Map<String,Double> getMetricsMap()
The metrics of the trained model.
map<string, double> metrics = 7;
getMetricsOrDefault(String key, double defaultValue)
public double getMetricsOrDefault(String key, double defaultValue)
The metrics of the trained model.
map<string, double> metrics = 7;
| Returns |
| Type |
Description |
double |
|
getMetricsOrThrow(String key)
public double getMetricsOrThrow(String key)
The metrics of the trained model.
map<string, double> metrics = 7;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
double |
|
getModelState()
public CustomTuningModel.ModelState getModelState()
The state that the model is in (e.g.TRAINING or TRAINING_FAILED).
.google.cloud.discoveryengine.v1.CustomTuningModel.ModelState model_state = 4;
getModelStateValue()
public int getModelStateValue()
The state that the model is in (e.g.TRAINING or TRAINING_FAILED).
.google.cloud.discoveryengine.v1.CustomTuningModel.ModelState model_state = 4;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for modelState.
|
getModelVersion()
public long getModelVersion()
The version of the model.
int64 model_version = 3;
| Returns |
| Type |
Description |
long |
The modelVersion.
|
getName()
Required. The fully qualified resource name of the model.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}
model must be an alpha-numerical string with limit of 40 characters.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. The fully qualified resource name of the model.
Format:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}
model must be an alpha-numerical string with limit of 40 characters.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<CustomTuningModel> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTrainingStartTime()
public Timestamp getTrainingStartTime()
Timestamp the model training was initiated.
.google.protobuf.Timestamp training_start_time = 6;
| Returns |
| Type |
Description |
Timestamp |
The trainingStartTime.
|
getTrainingStartTimeOrBuilder()
public TimestampOrBuilder getTrainingStartTimeOrBuilder()
Timestamp the model training was initiated.
.google.protobuf.Timestamp training_start_time = 6;
hasCreateTime() (deprecated)
public boolean hasCreateTime()
Deprecated. google.cloud.discoveryengine.v1.CustomTuningModel.create_time is deprecated. See
google/cloud/discoveryengine/v1/custom_tuning_model.proto;l=88
Deprecated: timestamp the Model was created at.
.google.protobuf.Timestamp create_time = 5 [deprecated = true];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasTrainingStartTime()
public boolean hasTrainingStartTime()
Timestamp the model training was initiated.
.google.protobuf.Timestamp training_start_time = 6;
| Returns |
| Type |
Description |
boolean |
Whether the trainingStartTime 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 CustomTuningModel.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CustomTuningModel.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CustomTuningModel.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
