Class Engine.RecommendationMetadata (0.40.0)

public static final class Engine.RecommendationMetadata extends GeneratedMessageV3 implements Engine.RecommendationMetadataOrBuilder

Additional information of a recommendation engine.

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

Static Fields

DATA_STATE_FIELD_NUMBER

public static final int DATA_STATE_FIELD_NUMBER
Field Value
Type Description
int

LAST_TUNE_TIME_FIELD_NUMBER

public static final int LAST_TUNE_TIME_FIELD_NUMBER
Field Value
Type Description
int

SERVING_STATE_FIELD_NUMBER

public static final int SERVING_STATE_FIELD_NUMBER
Field Value
Type Description
int

TUNING_OPERATION_FIELD_NUMBER

public static final int TUNING_OPERATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Engine.RecommendationMetadata getDefaultInstance()
Returns
Type Description
Engine.RecommendationMetadata

getDescriptor()

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

newBuilder()

public static Engine.RecommendationMetadata.Builder newBuilder()
Returns
Type Description
Engine.RecommendationMetadata.Builder

newBuilder(Engine.RecommendationMetadata prototype)

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

parseDelimitedFrom(InputStream input)

public static Engine.RecommendationMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Engine.RecommendationMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Engine.RecommendationMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Engine.RecommendationMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Engine.RecommendationMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Engine.RecommendationMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Engine.RecommendationMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Engine.RecommendationMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Engine.RecommendationMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Engine.RecommendationMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Engine.RecommendationMetadata> parser()
Returns
Type Description
Parser<RecommendationMetadata>

Methods

equals(Object obj)

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

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

Returns
Type Description
Engine.RecommendationMetadata.DataState

The dataState.

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

Returns
Type Description
int

The enum numeric value on the wire for dataState.

getDefaultInstanceForType()

public Engine.RecommendationMetadata getDefaultInstanceForType()
Returns
Type Description
Engine.RecommendationMetadata

getLastTuneTime()

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

Returns
Type Description
Timestamp

The lastTuneTime.

getLastTuneTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getParserForType()

public Parser<Engine.RecommendationMetadata> getParserForType()
Returns
Type Description
Parser<RecommendationMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

Returns
Type Description
Engine.RecommendationMetadata.ServingState

The servingState.

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

Returns
Type Description
int

The enum numeric value on the wire for servingState.

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

Returns
Type Description
String

The tuningOperation.

getTuningOperationBytes()

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

Returns
Type Description
ByteString

The bytes for tuningOperation.

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

Returns
Type Description
boolean

Whether the lastTuneTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Engine.RecommendationMetadata.Builder newBuilderForType()
Returns
Type Description
Engine.RecommendationMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Engine.RecommendationMetadata.Builder toBuilder()
Returns
Type Description
Engine.RecommendationMetadata.Builder

writeTo(CodedOutputStream output)

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