- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class Engine.RecommendationMetadata.Builder extends GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder> implements Engine.RecommendationMetadataOrBuilderAdditional information of a recommendation engine.
Protobuf type google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Engine.RecommendationMetadata.BuilderImplements
Engine.RecommendationMetadataOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Engine.RecommendationMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
build()
public Engine.RecommendationMetadata build()| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata |
|
buildPartial()
public Engine.RecommendationMetadata buildPartial()| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata |
|
clear()
public Engine.RecommendationMetadata.Builder clear()| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
clearDataState()
public Engine.RecommendationMetadata.Builder clearDataState() 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.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Engine.RecommendationMetadata.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
clearLastTuneTime()
public Engine.RecommendationMetadata.Builder clearLastTuneTime()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 |
Engine.RecommendationMetadata.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public Engine.RecommendationMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
clearServingState()
public Engine.RecommendationMetadata.Builder clearServingState() 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.Builder |
This builder for chaining. |
clearTuningOperation()
public Engine.RecommendationMetadata.Builder clearTuningOperation()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 |
Engine.RecommendationMetadata.Builder |
This builder for chaining. |
clone()
public Engine.RecommendationMetadata.Builder clone()| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getLastTuneTimeBuilder()
public Timestamp.Builder getLastTuneTimeBuilder()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 |
Builder |
|
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 |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Engine.RecommendationMetadata other)
public Engine.RecommendationMetadata.Builder mergeFrom(Engine.RecommendationMetadata other)| Parameter | |
|---|---|
| Name | Description |
other |
Engine.RecommendationMetadata |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Engine.RecommendationMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Engine.RecommendationMetadata.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
mergeLastTuneTime(Timestamp value)
public Engine.RecommendationMetadata.Builder mergeLastTuneTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Engine.RecommendationMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
setDataState(Engine.RecommendationMetadata.DataState value)
public Engine.RecommendationMetadata.Builder setDataState(Engine.RecommendationMetadata.DataState value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.RecommendationMetadata.DataStateThe dataState to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
This builder for chaining. |
setDataStateValue(int value)
public Engine.RecommendationMetadata.Builder setDataStateValue(int value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for dataState to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Engine.RecommendationMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
setLastTuneTime(Timestamp value)
public Engine.RecommendationMetadata.Builder setLastTuneTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
setLastTuneTime(Timestamp.Builder builderForValue)
public Engine.RecommendationMetadata.Builder setLastTuneTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Engine.RecommendationMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|
setServingState(Engine.RecommendationMetadata.ServingState value)
public Engine.RecommendationMetadata.Builder setServingState(Engine.RecommendationMetadata.ServingState value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.RecommendationMetadata.ServingStateThe servingState to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
This builder for chaining. |
setServingStateValue(int value)
public Engine.RecommendationMetadata.Builder setServingStateValue(int value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for servingState to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
This builder for chaining. |
setTuningOperation(String value)
public Engine.RecommendationMetadata.Builder setTuningOperation(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe tuningOperation to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
This builder for chaining. |
setTuningOperationBytes(ByteString value)
public Engine.RecommendationMetadata.Builder setTuningOperationBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for tuningOperation to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Engine.RecommendationMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Engine.RecommendationMetadata.Builder |
|