Class Engine.RecommendationMetadata.Builder (0.27.0)

public static final class Engine.RecommendationMetadata.Builder extends GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder> implements Engine.RecommendationMetadataOrBuilder

Additional information of a recommendation engine.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Engine.RecommendationMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Engine.RecommendationMetadata.Builder
Overrides

build()

public Engine.RecommendationMetadata build()
Returns
TypeDescription
Engine.RecommendationMetadata

buildPartial()

public Engine.RecommendationMetadata buildPartial()
Returns
TypeDescription
Engine.RecommendationMetadata

clear()

public Engine.RecommendationMetadata.Builder clear()
Returns
TypeDescription
Engine.RecommendationMetadata.Builder
Overrides

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
TypeDescription
Engine.RecommendationMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Engine.RecommendationMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Engine.RecommendationMetadata.Builder
Overrides

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
TypeDescription
Engine.RecommendationMetadata.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Engine.RecommendationMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Engine.RecommendationMetadata.Builder
Overrides

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
TypeDescription
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
TypeDescription
Engine.RecommendationMetadata.Builder

This builder for chaining.

clone()

public Engine.RecommendationMetadata.Builder clone()
Returns
TypeDescription
Engine.RecommendationMetadata.Builder
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for dataState.

getDefaultInstanceForType()

public Engine.RecommendationMetadata getDefaultInstanceForType()
Returns
TypeDescription
Engine.RecommendationMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the lastTuneTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Engine.RecommendationMetadata other)

public Engine.RecommendationMetadata.Builder mergeFrom(Engine.RecommendationMetadata other)
Parameter
NameDescription
otherEngine.RecommendationMetadata
Returns
TypeDescription
Engine.RecommendationMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Engine.RecommendationMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Engine.RecommendationMetadata.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Engine.RecommendationMetadata.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Engine.RecommendationMetadata.Builder
Overrides

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
NameDescription
valueTimestamp
Returns
TypeDescription
Engine.RecommendationMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Engine.RecommendationMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Engine.RecommendationMetadata.Builder
Overrides

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
NameDescription
valueEngine.RecommendationMetadata.DataState

The dataState to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for dataState to set.

Returns
TypeDescription
Engine.RecommendationMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Engine.RecommendationMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Engine.RecommendationMetadata.Builder
Overrides

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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
Engine.RecommendationMetadata.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Engine.RecommendationMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Engine.RecommendationMetadata.Builder
Overrides

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
NameDescription
valueEngine.RecommendationMetadata.ServingState

The servingState to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for servingState to set.

Returns
TypeDescription
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
NameDescription
valueString

The tuningOperation to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for tuningOperation to set.

Returns
TypeDescription
Engine.RecommendationMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Engine.RecommendationMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Engine.RecommendationMetadata.Builder
Overrides