Class CustomTuningModel (0.47.0)

public final class CustomTuningModel extends GeneratedMessageV3 implements CustomTuningModelOrBuilder

Metadata that describes a custom tuned model.

Protobuf type google.cloud.discoveryengine.v1beta.CustomTuningModel

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()
Returns
Type Description
CustomTuningModel

getDescriptor()

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

newBuilder()

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

newBuilder(CustomTuningModel prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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
Returns
Type Description
boolean

equals(Object obj)

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

getCreateTime() (deprecated)

public Timestamp getCreateTime()

Deprecated. google.cloud.discoveryengine.v1beta.CustomTuningModel.create_time is deprecated. See google/cloud/discoveryengine/v1beta/custom_tuning_model.proto;l=88

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()

Timestamp the Model was created at.

.google.protobuf.Timestamp create_time = 5 [deprecated = true];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public CustomTuningModel getDefaultInstanceForType()
Returns
Type Description
CustomTuningModel

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()

Use #getMetricsMap() instead.

Returns
Type Description
Map<String,Double>

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;

Returns
Type Description
Map<String,Double>

getMetricsOrDefault(String key, double defaultValue)

public double getMetricsOrDefault(String key, double defaultValue)

The metrics of the trained model.

map<string, double> metrics = 7;

Parameters
Name Description
key String
defaultValue double
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.v1beta.CustomTuningModel.ModelState model_state = 4;

Returns
Type Description
CustomTuningModel.ModelState

The modelState.

getModelStateValue()

public int getModelStateValue()

The state that the model is in (e.g.TRAINING or TRAINING_FAILED).

.google.cloud.discoveryengine.v1beta.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()

public String getName()

Required. The fully qualified resource name of the model.

Format: projects/{project_number}/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_number}/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()
Returns
Type Description
Parser<CustomTuningModel>
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;

Returns
Type Description
TimestampOrBuilder

hasCreateTime() (deprecated)

public boolean hasCreateTime()

Deprecated. google.cloud.discoveryengine.v1beta.CustomTuningModel.create_time is deprecated. See google/cloud/discoveryengine/v1beta/custom_tuning_model.proto;l=88

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()

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 CustomTuningModel.Builder newBuilderForType()
Returns
Type Description
CustomTuningModel.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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