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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int DATA_STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LAST_TUNE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int SERVING_STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int TUNING_OPERATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static Engine.RecommendationMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Engine.RecommendationMetadata.Builder newBuilder()
public static Engine.RecommendationMetadata.Builder newBuilder(Engine.RecommendationMetadata prototype)
public static Engine.RecommendationMetadata parseDelimitedFrom(InputStream input)
public static Engine.RecommendationMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Engine.RecommendationMetadata parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static Engine.RecommendationMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Engine.RecommendationMetadata parseFrom(ByteString data)
public static Engine.RecommendationMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Engine.RecommendationMetadata parseFrom(CodedInputStream input)
public static Engine.RecommendationMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Engine.RecommendationMetadata parseFrom(InputStream input)
public static Engine.RecommendationMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Engine.RecommendationMetadata parseFrom(ByteBuffer data)
public static Engine.RecommendationMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Engine.RecommendationMetadata> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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];
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.
|
public Engine.RecommendationMetadata getDefaultInstanceForType()
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.
|
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];
public Parser<Engine.RecommendationMetadata> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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];
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.
|
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.
|
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.
|
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.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public Engine.RecommendationMetadata.Builder newBuilderForType()
protected Engine.RecommendationMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public Engine.RecommendationMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
