com.google.cloud.discoveryengine.v1alpha

Class Engine.RecommendationMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata

All Implemented Interfaces:

Engine.RecommendationMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Engine

public static final class Engine.RecommendationMetadata
extends com.google.protobuf.GeneratedMessageV3
implements Engine.RecommendationMetadataOrBuilder

 Additional information of a recommendation engine.
 

Protobuf type google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Engine.RecommendationMetadata.Builder Additional information of a recommendation engine.
static class	Engine.RecommendationMetadata.DataState Describes whether this engine have sufficient training data to be continuously trained.
static class	Engine.RecommendationMetadata.ServingState The serving state of the recommendation engine.

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	DATA_STATE_FIELD_NUMBER
static int	LAST_TUNE_TIME_FIELD_NUMBER
static int	SERVING_STATE_FIELD_NUMBER
static int	TUNING_OPERATION_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)
Engine.RecommendationMetadata.DataState	getDataState() Output only.
int	getDataStateValue() Output only.
static Engine.RecommendationMetadata	getDefaultInstance()
Engine.RecommendationMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Timestamp	getLastTuneTime() Output only.
com.google.protobuf.TimestampOrBuilder	getLastTuneTimeOrBuilder() Output only.
com.google.protobuf.Parser<Engine.RecommendationMetadata>	getParserForType()
int	getSerializedSize()
Engine.RecommendationMetadata.ServingState	getServingState() Output only.
int	getServingStateValue() Output only.
String	getTuningOperation() Output only.
com.google.protobuf.ByteString	getTuningOperationBytes() Output only.
int	hashCode()
boolean	hasLastTuneTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Engine.RecommendationMetadata.Builder	newBuilder()
static Engine.RecommendationMetadata.Builder	newBuilder(Engine.RecommendationMetadata prototype)
Engine.RecommendationMetadata.Builder	newBuilderForType()
protected Engine.RecommendationMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Engine.RecommendationMetadata	parseDelimitedFrom(InputStream input)
static Engine.RecommendationMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine.RecommendationMetadata	parseFrom(byte[] data)
static Engine.RecommendationMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine.RecommendationMetadata	parseFrom(ByteBuffer data)
static Engine.RecommendationMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine.RecommendationMetadata	parseFrom(com.google.protobuf.ByteString data)
static Engine.RecommendationMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine.RecommendationMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static Engine.RecommendationMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine.RecommendationMetadata	parseFrom(InputStream input)
static Engine.RecommendationMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Engine.RecommendationMetadata>	parser()
Engine.RecommendationMetadata.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

SERVING_STATE_FIELD_NUMBER

public static final int SERVING_STATE_FIELD_NUMBER

See Also:

Constant Field Values

DATA_STATE_FIELD_NUMBER

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

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

getServingStateValue

public int getServingStateValue()

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

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.ServingState serving_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getServingStateValue in interface Engine.RecommendationMetadataOrBuilder

Returns:

The enum numeric value on the wire for servingState.

getServingState

public Engine.RecommendationMetadata.ServingState getServingState()

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

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.ServingState serving_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getServingState in interface Engine.RecommendationMetadataOrBuilder

Returns:

The servingState.

getDataStateValue

public int getDataStateValue()

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

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

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.DataState data_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getDataStateValue in interface Engine.RecommendationMetadataOrBuilder

Returns:

The enum numeric value on the wire for dataState.

getDataState

public Engine.RecommendationMetadata.DataState getDataState()

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

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

.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.DataState data_state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getDataState in interface Engine.RecommendationMetadataOrBuilder

Returns:

The dataState.

hasLastTuneTime

public boolean hasLastTuneTime()

 Output only. The timestamp when the latest successful tune finished. Only
 applicable on Media Recommendation engines.
 

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

Specified by:

hasLastTuneTime in interface Engine.RecommendationMetadataOrBuilder

Returns:

Whether the lastTuneTime field is set.

getLastTuneTime

public com.google.protobuf.Timestamp getLastTuneTime()

 Output only. The timestamp when the latest successful tune finished. Only
 applicable on Media Recommendation engines.
 

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

Specified by:

getLastTuneTime in interface Engine.RecommendationMetadataOrBuilder

Returns:

The lastTuneTime.

getLastTuneTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getLastTuneTimeOrBuilder()

 Output only. The timestamp when the latest successful tune finished. Only
 applicable on Media Recommendation engines.
 

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

Specified by:

getLastTuneTimeOrBuilder in interface Engine.RecommendationMetadataOrBuilder

getTuningOperation

public String getTuningOperation()

 Output only. The latest tune operation id associated with the engine.
 Only applicable on Media Recommendation engines.

 If present, this operation id can be used to determine if there is an
 ongoing tune for this engine. To check the operation status, send the
 GetOperation request with this operation id in the engine resource
 format. If no tuning has happened for this engine, the string is empty.
 

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

Specified by:

getTuningOperation in interface Engine.RecommendationMetadataOrBuilder

Returns:

The tuningOperation.

getTuningOperationBytes

public com.google.protobuf.ByteString getTuningOperationBytes()

 Output only. The latest tune operation id associated with the engine.
 Only applicable on Media Recommendation engines.

 If present, this operation id can be used to determine if there is an
 ongoing tune for this engine. To check the operation status, send the
 GetOperation request with this operation id in the engine resource
 format. If no tuning has happened for this engine, the string is empty.
 

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

Specified by:

getTuningOperationBytes in interface Engine.RecommendationMetadataOrBuilder

Returns:

The bytes for tuningOperation.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Engine.RecommendationMetadata parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Engine.RecommendationMetadata parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Engine.RecommendationMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Engine.RecommendationMetadata.Builder newBuilder()

newBuilder

public static Engine.RecommendationMetadata.Builder newBuilder(Engine.RecommendationMetadata prototype)

toBuilder

public Engine.RecommendationMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Engine.RecommendationMetadata getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder