Class CustomTuningModel (0.50.0)

Version 0.50.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public final class CustomTuningModel extends GeneratedMessageV3 implements CustomTuningModelOrBuilder

Metadata that describes a custom tuned model.

Protobuf type google.cloud.discoveryengine.v1beta.CustomTuningModel

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CustomTuningModel

Implements

CustomTuningModelOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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

ERROR_MESSAGE_FIELD_NUMBER

public static final int ERROR_MESSAGE_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

AbstractMessage.equals(Object other)

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=89

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];

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.

getErrorMessage()

public String getErrorMessage()

Currently this is only populated if the model state is INPUT_VALIDATION_FAILED.

string error_message = 8;

Returns
Type	Description
String	The errorMessage.

getErrorMessageBytes()

public ByteString getErrorMessageBytes()

Currently this is only populated if the model state is INPUT_VALIDATION_FAILED.

string error_message = 8;

Returns
Type	Description
ByteString	The bytes for errorMessage.

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

Returns
Type	Description
Parser<CustomTuningModel>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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=89

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

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

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

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CustomTuningModel.Builder toBuilder()

Returns
Type	Description
CustomTuningModel.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException