com.google.cloud.retail.v2alpha

Class Model

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2alpha.Model

All Implemented Interfaces:

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

public final class Model
extends com.google.protobuf.GeneratedMessageV3
implements ModelOrBuilder

 Metadata that describes the training and serving parameters of a
 [Model][google.cloud.retail.v2alpha.Model]. A
 [Model][google.cloud.retail.v2alpha.Model] can be associated with a
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] and then queried
 through the Predict API.
 

Protobuf type google.cloud.retail.v2alpha.Model

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Model.Builder Metadata that describes the training and serving parameters of a [Model][google.cloud.retail.v2alpha.Model].
static class	Model.DataState Describes whether this model have sufficient training data to be continuously trained.
static class	Model.PageOptimizationConfig The PageOptimizationConfig for model training.
static interface	Model.PageOptimizationConfigOrBuilder
static class	Model.PeriodicTuningState Describes whether periodic tuning is enabled for this model or not.
static class	Model.ServingConfigList Represents an ordered combination of valid serving configs, which can be used for `PAGE_OPTIMIZATION` recommendations.
static interface	Model.ServingConfigListOrBuilder
static class	Model.ServingState The serving state of the model.
static class	Model.TrainingConfigCase
static class	Model.TrainingState The training 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	DATA_STATE_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	FILTERING_OPTION_FIELD_NUMBER
static int	LAST_TUNE_TIME_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	OPTIMIZATION_OBJECTIVE_FIELD_NUMBER
static int	PAGE_OPTIMIZATION_CONFIG_FIELD_NUMBER
static int	PERIODIC_TUNING_STATE_FIELD_NUMBER
static int	SERVING_CONFIG_LISTS_FIELD_NUMBER
static int	SERVING_STATE_FIELD_NUMBER
static int	TRAINING_STATE_FIELD_NUMBER
static int	TUNING_OPERATION_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER
static int	UPDATE_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	equals(Object obj)
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
Model.DataState	getDataState() Output only.
int	getDataStateValue() Output only.
static Model	getDefaultInstance()
Model	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
RecommendationsFilteringOption	getFilteringOption() Optional.
int	getFilteringOptionValue() Optional.
com.google.protobuf.Timestamp	getLastTuneTime() Output only.
com.google.protobuf.TimestampOrBuilder	getLastTuneTimeOrBuilder() Output only.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
String	getOptimizationObjective() Optional.
com.google.protobuf.ByteString	getOptimizationObjectiveBytes() Optional.
Model.PageOptimizationConfig	getPageOptimizationConfig() Optional.
Model.PageOptimizationConfigOrBuilder	getPageOptimizationConfigOrBuilder() Optional.
com.google.protobuf.Parser<Model>	getParserForType()
Model.PeriodicTuningState	getPeriodicTuningState() Optional.
int	getPeriodicTuningStateValue() Optional.
int	getSerializedSize()
Model.ServingConfigList	getServingConfigLists(int index) Output only.
int	getServingConfigListsCount() Output only.
List<Model.ServingConfigList>	getServingConfigListsList() Output only.
Model.ServingConfigListOrBuilder	getServingConfigListsOrBuilder(int index) Output only.
List<? extends Model.ServingConfigListOrBuilder>	getServingConfigListsOrBuilderList() Output only.
Model.ServingState	getServingState() Output only.
int	getServingStateValue() Output only.
Model.TrainingConfigCase	getTrainingConfigCase()
Model.TrainingState	getTrainingState() Optional.
int	getTrainingStateValue() Optional.
String	getTuningOperation() Output only.
com.google.protobuf.ByteString	getTuningOperationBytes() Output only.
String	getType() Required.
com.google.protobuf.ByteString	getTypeBytes() Required.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
int	hashCode()
boolean	hasLastTuneTime() Output only.
boolean	hasPageOptimizationConfig() Optional.
boolean	hasUpdateTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Model.Builder	newBuilder()
static Model.Builder	newBuilder(Model prototype)
Model.Builder	newBuilderForType()
protected Model.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Model	parseDelimitedFrom(InputStream input)
static Model	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Model	parseFrom(byte[] data)
static Model	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Model	parseFrom(ByteBuffer data)
static Model	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Model	parseFrom(com.google.protobuf.ByteString data)
static Model	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Model	parseFrom(com.google.protobuf.CodedInputStream input)
static Model	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Model	parseFrom(InputStream input)
static Model	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Model>	parser()
Model.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, internalGetMapFieldReflection, 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

PAGE_OPTIMIZATION_CONFIG_FIELD_NUMBER

public static final int PAGE_OPTIMIZATION_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

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

TRAINING_STATE_FIELD_NUMBER

public static final int TRAINING_STATE_FIELD_NUMBER

See Also:

Constant Field Values

SERVING_STATE_FIELD_NUMBER

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

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

OPTIMIZATION_OBJECTIVE_FIELD_NUMBER

public static final int OPTIMIZATION_OBJECTIVE_FIELD_NUMBER

See Also:

Constant Field Values

PERIODIC_TUNING_STATE_FIELD_NUMBER

public static final int PERIODIC_TUNING_STATE_FIELD_NUMBER

See Also:

Constant Field Values

LAST_TUNE_TIME_FIELD_NUMBER

public static final int LAST_TUNE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

TUNING_OPERATION_FIELD_NUMBER

public static final int TUNING_OPERATION_FIELD_NUMBER

See Also:

Constant Field Values

DATA_STATE_FIELD_NUMBER

public static final int DATA_STATE_FIELD_NUMBER

See Also:

Constant Field Values

FILTERING_OPTION_FIELD_NUMBER

public static final int FILTERING_OPTION_FIELD_NUMBER

See Also:

Constant Field Values

SERVING_CONFIG_LISTS_FIELD_NUMBER

public static final int SERVING_CONFIG_LISTS_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()

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getTrainingConfigCase

public Model.TrainingConfigCase getTrainingConfigCase()

Specified by:

getTrainingConfigCase in interface ModelOrBuilder

hasPageOptimizationConfig

public boolean hasPageOptimizationConfig()

 Optional. The page optimization config.
 

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasPageOptimizationConfig in interface ModelOrBuilder

Returns:

Whether the pageOptimizationConfig field is set.

getPageOptimizationConfig

public Model.PageOptimizationConfig getPageOptimizationConfig()

 Optional. The page optimization config.
 

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPageOptimizationConfig in interface ModelOrBuilder

Returns:

The pageOptimizationConfig.

getPageOptimizationConfigOrBuilder

public Model.PageOptimizationConfigOrBuilder getPageOptimizationConfigOrBuilder()

 Optional. The page optimization config.
 

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPageOptimizationConfigOrBuilder in interface ModelOrBuilder

getName

public String getName()

 Required. The fully qualified resource name of the model.

 Format:
 `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
 catalog_id has char limit of 50.
 recommendation_model_id has char limit of 40.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getName in interface ModelOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Required. The fully qualified resource name of the model.

 Format:
 `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
 catalog_id has char limit of 50.
 recommendation_model_id has char limit of 40.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getNameBytes in interface ModelOrBuilder

Returns:

The bytes for name.

getDisplayName

public String getDisplayName()

 Required. The display name of the model.

 Should be human readable, used to display Recommendation Models in the
 Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024
 characters.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDisplayName in interface ModelOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 Required. The display name of the model.

 Should be human readable, used to display Recommendation Models in the
 Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024
 characters.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDisplayNameBytes in interface ModelOrBuilder

Returns:

The bytes for displayName.

getTrainingStateValue

public int getTrainingStateValue()

 Optional. The training state that the model is in (e.g.
 `TRAINING` or `PAUSED`).

 Since part of the cost of running the service
 is frequency of training - this can be used to determine when to train
 model in order to control cost. If not specified: the default value for
 `CreateModel` method is `TRAINING`. The default value for
 `UpdateModel` method is to keep the state the same as before.
 

.google.cloud.retail.v2alpha.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getTrainingStateValue in interface ModelOrBuilder

Returns:

The enum numeric value on the wire for trainingState.

getTrainingState

public Model.TrainingState getTrainingState()

 Optional. The training state that the model is in (e.g.
 `TRAINING` or `PAUSED`).

 Since part of the cost of running the service
 is frequency of training - this can be used to determine when to train
 model in order to control cost. If not specified: the default value for
 `CreateModel` method is `TRAINING`. The default value for
 `UpdateModel` method is to keep the state the same as before.
 

.google.cloud.retail.v2alpha.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getTrainingState in interface ModelOrBuilder

Returns:

The trainingState.

getServingStateValue

public int getServingStateValue()

 Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
 

.google.cloud.retail.v2alpha.Model.ServingState serving_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getServingStateValue in interface ModelOrBuilder

Returns:

The enum numeric value on the wire for servingState.

getServingState

public Model.ServingState getServingState()

 Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
 

.google.cloud.retail.v2alpha.Model.ServingState serving_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getServingState in interface ModelOrBuilder

Returns:

The servingState.

hasCreateTime

public boolean hasCreateTime()

 Output only. Timestamp the Recommendation Model was created at.
 

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasCreateTime in interface ModelOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp the Recommendation Model was created at.
 

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCreateTime in interface ModelOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp the Recommendation Model was created at.
 

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCreateTimeOrBuilder in interface ModelOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 Output only. Timestamp the Recommendation Model was last updated. E.g.
 if a Recommendation Model was paused - this would be the time the pause was
 initiated.
 

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasUpdateTime in interface ModelOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

 Output only. Timestamp the Recommendation Model was last updated. E.g.
 if a Recommendation Model was paused - this would be the time the pause was
 initiated.
 

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getUpdateTime in interface ModelOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Timestamp the Recommendation Model was last updated. E.g.
 if a Recommendation Model was paused - this would be the time the pause was
 initiated.
 

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getUpdateTimeOrBuilder in interface ModelOrBuilder

getType

public String getType()

 Required. The type of model e.g. `home-page`.

 Currently supported values: `recommended-for-you`, `others-you-may-like`,
 `frequently-bought-together`, `page-optimization`, `similar-items`,
 `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value).


 This field together with
 [optimization_objective][google.cloud.retail.v2alpha.Model.optimization_objective]
 describe model metadata to use to control model training and serving.
 See https://cloud.google.com/retail/docs/models
 for more details on what the model metadata control and which combination
 of parameters are valid. For invalid combinations of parameters (e.g. type
 = `frequently-bought-together` and optimization_objective = `ctr`), you
 receive an error 400 if you try to create/update a recommendation with
 this set of knobs.
 

string type = 7 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getType in interface ModelOrBuilder

Returns:

The type.

getTypeBytes

public com.google.protobuf.ByteString getTypeBytes()

 Required. The type of model e.g. `home-page`.

 Currently supported values: `recommended-for-you`, `others-you-may-like`,
 `frequently-bought-together`, `page-optimization`, `similar-items`,
 `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value).


 This field together with
 [optimization_objective][google.cloud.retail.v2alpha.Model.optimization_objective]
 describe model metadata to use to control model training and serving.
 See https://cloud.google.com/retail/docs/models
 for more details on what the model metadata control and which combination
 of parameters are valid. For invalid combinations of parameters (e.g. type
 = `frequently-bought-together` and optimization_objective = `ctr`), you
 receive an error 400 if you try to create/update a recommendation with
 this set of knobs.
 

string type = 7 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getTypeBytes in interface ModelOrBuilder

Returns:

The bytes for type.

getOptimizationObjective

public String getOptimizationObjective()

 Optional. The optimization objective e.g. `cvr`.

 Currently supported
 values: `ctr`, `cvr`, `revenue-per-order`.

  If not specified, we choose default based on model type.
 Default depends on type of recommendation:

 `recommended-for-you` => `ctr`

 `others-you-may-like` => `ctr`

 `frequently-bought-together` => `revenue_per_order`

 This field together with
 [optimization_objective][google.cloud.retail.v2alpha.Model.type]
 describe model metadata to use to control model training and serving.
 See https://cloud.google.com/retail/docs/models
 for more details on what the model metadata control and which combination
 of parameters are valid. For invalid combinations of parameters (e.g. type
 = `frequently-bought-together` and optimization_objective = `ctr`), you
 receive an error 400 if you try to create/update a recommendation with
 this set of knobs.
 

string optimization_objective = 8 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getOptimizationObjective in interface ModelOrBuilder

Returns:

The optimizationObjective.

getOptimizationObjectiveBytes

public com.google.protobuf.ByteString getOptimizationObjectiveBytes()

 Optional. The optimization objective e.g. `cvr`.

 Currently supported
 values: `ctr`, `cvr`, `revenue-per-order`.

  If not specified, we choose default based on model type.
 Default depends on type of recommendation:

 `recommended-for-you` => `ctr`

 `others-you-may-like` => `ctr`

 `frequently-bought-together` => `revenue_per_order`

 This field together with
 [optimization_objective][google.cloud.retail.v2alpha.Model.type]
 describe model metadata to use to control model training and serving.
 See https://cloud.google.com/retail/docs/models
 for more details on what the model metadata control and which combination
 of parameters are valid. For invalid combinations of parameters (e.g. type
 = `frequently-bought-together` and optimization_objective = `ctr`), you
 receive an error 400 if you try to create/update a recommendation with
 this set of knobs.
 

string optimization_objective = 8 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getOptimizationObjectiveBytes in interface ModelOrBuilder

Returns:

The bytes for optimizationObjective.

getPeriodicTuningStateValue

public int getPeriodicTuningStateValue()

 Optional. The state of periodic tuning.

 The period we use is 3 months - to do a
 one-off tune earlier use the `TuneModel` method. Default value
 is `PERIODIC_TUNING_ENABLED`.
 

.google.cloud.retail.v2alpha.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPeriodicTuningStateValue in interface ModelOrBuilder

Returns:

The enum numeric value on the wire for periodicTuningState.

getPeriodicTuningState

public Model.PeriodicTuningState getPeriodicTuningState()

 Optional. The state of periodic tuning.

 The period we use is 3 months - to do a
 one-off tune earlier use the `TuneModel` method. Default value
 is `PERIODIC_TUNING_ENABLED`.
 

.google.cloud.retail.v2alpha.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPeriodicTuningState in interface ModelOrBuilder

Returns:

The periodicTuningState.

hasLastTuneTime

public boolean hasLastTuneTime()

 Output only. The timestamp when the latest successful tune finished.
 

.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasLastTuneTime in interface ModelOrBuilder

Returns:

Whether the lastTuneTime field is set.

getLastTuneTime

public com.google.protobuf.Timestamp getLastTuneTime()

 Output only. The timestamp when the latest successful tune finished.
 

.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getLastTuneTime in interface ModelOrBuilder

Returns:

The lastTuneTime.

getLastTuneTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getLastTuneTimeOrBuilder()

 Output only. The timestamp when the latest successful tune finished.
 

.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getLastTuneTimeOrBuilder in interface ModelOrBuilder

getTuningOperation

public String getTuningOperation()

 Output only. The tune operation associated with the model.

 Can be used to determine if there is an ongoing tune for this
 recommendation. Empty field implies no tune is goig on.
 

string tuning_operation = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getTuningOperation in interface ModelOrBuilder

Returns:

The tuningOperation.

getTuningOperationBytes

public com.google.protobuf.ByteString getTuningOperationBytes()

 Output only. The tune operation associated with the model.

 Can be used to determine if there is an ongoing tune for this
 recommendation. Empty field implies no tune is goig on.
 

string tuning_operation = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getTuningOperationBytes in interface ModelOrBuilder

Returns:

The bytes for tuningOperation.

getDataStateValue

public int getDataStateValue()

 Output only. The state of data requirements for this model: `DATA_OK` and
 `DATA_ERROR`.

 Recommendation model cannot be trained if the data is in
 `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even
 if serving state is `ACTIVE`: models were trained successfully before, but
 cannot be refreshed because model no longer has sufficient
 data for training.
 

.google.cloud.retail.v2alpha.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getDataStateValue in interface ModelOrBuilder

Returns:

The enum numeric value on the wire for dataState.

getDataState

public Model.DataState getDataState()

 Output only. The state of data requirements for this model: `DATA_OK` and
 `DATA_ERROR`.

 Recommendation model cannot be trained if the data is in
 `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even
 if serving state is `ACTIVE`: models were trained successfully before, but
 cannot be refreshed because model no longer has sufficient
 data for training.
 

.google.cloud.retail.v2alpha.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getDataState in interface ModelOrBuilder

Returns:

The dataState.

getFilteringOptionValue

public int getFilteringOptionValue()

 Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering
 by attributes is enabled for the model.
 

.google.cloud.retail.v2alpha.RecommendationsFilteringOption filtering_option = 18 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilteringOptionValue in interface ModelOrBuilder

Returns:

The enum numeric value on the wire for filteringOption.

getFilteringOption

public RecommendationsFilteringOption getFilteringOption()

 Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering
 by attributes is enabled for the model.
 

.google.cloud.retail.v2alpha.RecommendationsFilteringOption filtering_option = 18 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilteringOption in interface ModelOrBuilder

Returns:

The filteringOption.

getServingConfigListsList

public List<Model.ServingConfigList> getServingConfigListsList()

 Output only. The list of valid serving configs associated with the
 PageOptimizationConfig.
 

repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getServingConfigListsList in interface ModelOrBuilder

getServingConfigListsOrBuilderList

public List<? extends Model.ServingConfigListOrBuilder> getServingConfigListsOrBuilderList()

 Output only. The list of valid serving configs associated with the
 PageOptimizationConfig.
 

repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getServingConfigListsOrBuilderList in interface ModelOrBuilder

getServingConfigListsCount

public int getServingConfigListsCount()

 Output only. The list of valid serving configs associated with the
 PageOptimizationConfig.
 

repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getServingConfigListsCount in interface ModelOrBuilder

getServingConfigLists

public Model.ServingConfigList getServingConfigLists(int index)

 Output only. The list of valid serving configs associated with the
 PageOptimizationConfig.
 

repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getServingConfigLists in interface ModelOrBuilder

getServingConfigListsOrBuilder

public Model.ServingConfigListOrBuilder getServingConfigListsOrBuilder(int index)

 Output only. The list of valid serving configs associated with the
 PageOptimizationConfig.
 

repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getServingConfigListsOrBuilder in interface ModelOrBuilder

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 Model parseFrom(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Model parseFrom(InputStream input)
                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Model parseDelimitedFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Model.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Model.Builder newBuilder()

newBuilder

public static Model.Builder newBuilder(Model prototype)

toBuilder

public Model.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Model getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Model> 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 Model getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder