com.google.cloud.discoveryengine.v1beta

Class CustomTuningModel

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.CustomTuningModel

All Implemented Interfaces:

CustomTuningModelOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class CustomTuningModel
extends com.google.protobuf.GeneratedMessageV3
implements CustomTuningModelOrBuilder

 Metadata that describes a custom tuned model.
 

Protobuf type google.cloud.discoveryengine.v1beta.CustomTuningModel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomTuningModel.Builder Metadata that describes a custom tuned model.
static class	CustomTuningModel.ModelState The state of the model.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CREATE_TIME_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	ERROR_MESSAGE_FIELD_NUMBER
static int	METRICS_FIELD_NUMBER
static int	MODEL_STATE_FIELD_NUMBER
static int	MODEL_VERSION_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	TRAINING_START_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsMetrics(String key) The metrics of the trained model.
boolean	equals(Object obj)
com.google.protobuf.Timestamp	getCreateTime() Deprecated. google.cloud.discoveryengine.v1beta.CustomTuningModel.create_time is deprecated. See google/cloud/discoveryengine/v1beta/custom_tuning_model.proto;l=89
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Deprecated.
static CustomTuningModel	getDefaultInstance()
CustomTuningModel	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() The display name of the model.
com.google.protobuf.ByteString	getDisplayNameBytes() The display name of the model.
String	getErrorMessage() Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.
com.google.protobuf.ByteString	getErrorMessageBytes() Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.
Map<String,Double>	getMetrics() Deprecated.
int	getMetricsCount() The metrics of the trained model.
Map<String,Double>	getMetricsMap() The metrics of the trained model.
double	getMetricsOrDefault(String key, double defaultValue) The metrics of the trained model.
double	getMetricsOrThrow(String key) The metrics of the trained model.
CustomTuningModel.ModelState	getModelState() The state that the model is in (e.g.
int	getModelStateValue() The state that the model is in (e.g.
long	getModelVersion() The version of the model.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
com.google.protobuf.Parser<CustomTuningModel>	getParserForType()
int	getSerializedSize()
com.google.protobuf.Timestamp	getTrainingStartTime() Timestamp the model training was initiated.
com.google.protobuf.TimestampOrBuilder	getTrainingStartTimeOrBuilder() Timestamp the model training was initiated.
boolean	hasCreateTime() Deprecated. google.cloud.discoveryengine.v1beta.CustomTuningModel.create_time is deprecated. See google/cloud/discoveryengine/v1beta/custom_tuning_model.proto;l=89
int	hashCode()
boolean	hasTrainingStartTime() Timestamp the model training was initiated.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static CustomTuningModel.Builder	newBuilder()
static CustomTuningModel.Builder	newBuilder(CustomTuningModel prototype)
CustomTuningModel.Builder	newBuilderForType()
protected CustomTuningModel.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CustomTuningModel	parseDelimitedFrom(InputStream input)
static CustomTuningModel	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomTuningModel	parseFrom(byte[] data)
static CustomTuningModel	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomTuningModel	parseFrom(ByteBuffer data)
static CustomTuningModel	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomTuningModel	parseFrom(com.google.protobuf.ByteString data)
static CustomTuningModel	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomTuningModel	parseFrom(com.google.protobuf.CodedInputStream input)
static CustomTuningModel	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomTuningModel	parseFrom(InputStream input)
static CustomTuningModel	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CustomTuningModel>	parser()
CustomTuningModel.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

MODEL_VERSION_FIELD_NUMBER

public static final int MODEL_VERSION_FIELD_NUMBER

See Also:

Constant Field Values

MODEL_STATE_FIELD_NUMBER

public static final int MODEL_STATE_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

TRAINING_START_TIME_FIELD_NUMBER

public static final int TRAINING_START_TIME_FIELD_NUMBER

See Also:

Constant Field Values

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER

See Also:

Constant Field Values

ERROR_MESSAGE_FIELD_NUMBER

public static final int ERROR_MESSAGE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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) = { ... }

Specified by:

getName in interface CustomTuningModelOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.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) = { ... }

Specified by:

getNameBytes in interface CustomTuningModelOrBuilder

Returns:

The bytes for name.

getDisplayName

public String getDisplayName()

 The display name of the model.
 

string display_name = 2;

Specified by:

getDisplayName in interface CustomTuningModelOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 The display name of the model.
 

string display_name = 2;

Specified by:

getDisplayNameBytes in interface CustomTuningModelOrBuilder

Returns:

The bytes for displayName.

getModelVersion

public long getModelVersion()

 The version of the model.
 

int64 model_version = 3;

Specified by:

getModelVersion in interface CustomTuningModelOrBuilder

Returns:

The modelVersion.

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;

Specified by:

getModelStateValue in interface CustomTuningModelOrBuilder

Returns:

The enum numeric value on the wire for modelState.

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;

Specified by:

getModelState in interface CustomTuningModelOrBuilder

Returns:

The modelState.

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

Specified by:

hasCreateTime in interface CustomTuningModelOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

@Deprecated
public com.google.protobuf.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];

Specified by:

getCreateTime in interface CustomTuningModelOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

@Deprecated
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

Deprecated.

 Deprecated: Timestamp the Model was created at.
 

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

Specified by:

getCreateTimeOrBuilder in interface CustomTuningModelOrBuilder

hasTrainingStartTime

public boolean hasTrainingStartTime()

 Timestamp the model training was initiated.
 

.google.protobuf.Timestamp training_start_time = 6;

Specified by:

hasTrainingStartTime in interface CustomTuningModelOrBuilder

Returns:

Whether the trainingStartTime field is set.

getTrainingStartTime

public com.google.protobuf.Timestamp getTrainingStartTime()

 Timestamp the model training was initiated.
 

.google.protobuf.Timestamp training_start_time = 6;

Specified by:

getTrainingStartTime in interface CustomTuningModelOrBuilder

Returns:

The trainingStartTime.

getTrainingStartTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getTrainingStartTimeOrBuilder()

 Timestamp the model training was initiated.
 

.google.protobuf.Timestamp training_start_time = 6;

Specified by:

getTrainingStartTimeOrBuilder in interface CustomTuningModelOrBuilder

getMetricsCount

public int getMetricsCount()

Description copied from interface: CustomTuningModelOrBuilder

 The metrics of the trained model.
 

map<string, double> metrics = 7;

Specified by:

getMetricsCount in interface CustomTuningModelOrBuilder

containsMetrics

public boolean containsMetrics(String key)

 The metrics of the trained model.
 

map<string, double> metrics = 7;

Specified by:

containsMetrics in interface CustomTuningModelOrBuilder

getMetrics

@Deprecated
public Map<String,Double> getMetrics()

Deprecated.

Use getMetricsMap() instead.

Specified by:

getMetrics in interface CustomTuningModelOrBuilder

getMetricsMap

public Map<String,Double> getMetricsMap()

 The metrics of the trained model.
 

map<string, double> metrics = 7;

Specified by:

getMetricsMap in interface CustomTuningModelOrBuilder

getMetricsOrDefault

public double getMetricsOrDefault(String key,
                                  double defaultValue)

 The metrics of the trained model.
 

map<string, double> metrics = 7;

Specified by:

getMetricsOrDefault in interface CustomTuningModelOrBuilder

getMetricsOrThrow

public double getMetricsOrThrow(String key)

 The metrics of the trained model.
 

map<string, double> metrics = 7;

Specified by:

getMetricsOrThrow in interface CustomTuningModelOrBuilder

getErrorMessage

public String getErrorMessage()

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

string error_message = 8;

Specified by:

getErrorMessage in interface CustomTuningModelOrBuilder

Returns:

The errorMessage.

getErrorMessageBytes

public com.google.protobuf.ByteString getErrorMessageBytes()

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

string error_message = 8;

Specified by:

getErrorMessageBytes in interface CustomTuningModelOrBuilder

Returns:

The bytes for errorMessage.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static CustomTuningModel parseFrom(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomTuningModel parseFrom(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomTuningModel parseFrom(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomTuningModel parseFrom(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomTuningModel parseFrom(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomTuningModel parseFrom(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomTuningModel parseFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static CustomTuningModel parseFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static CustomTuningModel parseDelimitedFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static CustomTuningModel parseDelimitedFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseFrom

public static CustomTuningModel parseFrom(com.google.protobuf.CodedInputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static CustomTuningModel parseFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

newBuilderForType

public CustomTuningModel.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CustomTuningModel.Builder newBuilder()

newBuilder

public static CustomTuningModel.Builder newBuilder(CustomTuningModel prototype)

toBuilder

public CustomTuningModel.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected CustomTuningModel.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CustomTuningModel getDefaultInstance()

parser

public static com.google.protobuf.Parser<CustomTuningModel> parser()

getParserForType

public com.google.protobuf.Parser<CustomTuningModel> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public CustomTuningModel getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder