com.google.cloud.discoveryengine.v1alpha

Class Engine.RecommendationMetadata.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder>

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

All Implemented Interfaces:

Engine.RecommendationMetadataOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Engine.RecommendationMetadata

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

 Additional information of a recommendation engine.
 

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

Method Summary

Modifier and Type	Method and Description
Engine.RecommendationMetadata.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Engine.RecommendationMetadata	build()
Engine.RecommendationMetadata	buildPartial()
Engine.RecommendationMetadata.Builder	clear()
Engine.RecommendationMetadata.Builder	clearDataState() Output only.
Engine.RecommendationMetadata.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Engine.RecommendationMetadata.Builder	clearLastTuneTime() Output only.
Engine.RecommendationMetadata.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Engine.RecommendationMetadata.Builder	clearServingState() Output only.
Engine.RecommendationMetadata.Builder	clearTuningOperation() Output only.
Engine.RecommendationMetadata.Builder	clone()
Engine.RecommendationMetadata.DataState	getDataState() Output only.
int	getDataStateValue() Output only.
Engine.RecommendationMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
com.google.protobuf.Timestamp	getLastTuneTime() Output only.
com.google.protobuf.Timestamp.Builder	getLastTuneTimeBuilder() Output only.
com.google.protobuf.TimestampOrBuilder	getLastTuneTimeOrBuilder() Output only.
Engine.RecommendationMetadata.ServingState	getServingState() Output only.
int	getServingStateValue() Output only.
String	getTuningOperation() Output only.
com.google.protobuf.ByteString	getTuningOperationBytes() Output only.
boolean	hasLastTuneTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Engine.RecommendationMetadata.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Engine.RecommendationMetadata.Builder	mergeFrom(Engine.RecommendationMetadata other)
Engine.RecommendationMetadata.Builder	mergeFrom(com.google.protobuf.Message other)
Engine.RecommendationMetadata.Builder	mergeLastTuneTime(com.google.protobuf.Timestamp value) Output only.
Engine.RecommendationMetadata.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Engine.RecommendationMetadata.Builder	setDataState(Engine.RecommendationMetadata.DataState value) Output only.
Engine.RecommendationMetadata.Builder	setDataStateValue(int value) Output only.
Engine.RecommendationMetadata.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Engine.RecommendationMetadata.Builder	setLastTuneTime(com.google.protobuf.Timestamp.Builder builderForValue) Output only.
Engine.RecommendationMetadata.Builder	setLastTuneTime(com.google.protobuf.Timestamp value) Output only.
Engine.RecommendationMetadata.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Engine.RecommendationMetadata.Builder	setServingState(Engine.RecommendationMetadata.ServingState value) Output only.
Engine.RecommendationMetadata.Builder	setServingStateValue(int value) Output only.
Engine.RecommendationMetadata.Builder	setTuningOperation(String value) Output only.
Engine.RecommendationMetadata.Builder	setTuningOperationBytes(com.google.protobuf.ByteString value) Output only.
Engine.RecommendationMetadata.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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

clear

public Engine.RecommendationMetadata.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder>

getDefaultInstanceForType

public Engine.RecommendationMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Engine.RecommendationMetadata build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Engine.RecommendationMetadata buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Engine.RecommendationMetadata.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder>

setField

public Engine.RecommendationMetadata.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder>

clearField

public Engine.RecommendationMetadata.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder>

clearOneof

public Engine.RecommendationMetadata.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder>

setRepeatedField

public Engine.RecommendationMetadata.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                              int index,
                                                              Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder>

addRepeatedField

public Engine.RecommendationMetadata.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                              Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder>

mergeFrom

public Engine.RecommendationMetadata.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Engine.RecommendationMetadata.Builder>

mergeFrom

public Engine.RecommendationMetadata.Builder mergeFrom(Engine.RecommendationMetadata other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Engine.RecommendationMetadata.Builder>

Throws:

IOException

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.

setServingStateValue

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

Parameters:

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

Returns:

This builder for chaining.

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.

setServingState

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

Parameters:

value - The servingState to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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.

setDataStateValue

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

Parameters:

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

Returns:

This builder for chaining.

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.

setDataState

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

Parameters:

value - The dataState to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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.

setLastTuneTime

public Engine.RecommendationMetadata.Builder setLastTuneTime(com.google.protobuf.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];

setLastTuneTime

public Engine.RecommendationMetadata.Builder setLastTuneTime(com.google.protobuf.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];

mergeLastTuneTime

public Engine.RecommendationMetadata.Builder mergeLastTuneTime(com.google.protobuf.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];

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

getLastTuneTimeBuilder

public com.google.protobuf.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];

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.

setTuningOperation

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

Parameters:

value - The tuningOperation to set.

Returns:

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:

This builder for chaining.

setTuningOperationBytes

public Engine.RecommendationMetadata.Builder setTuningOperationBytes(com.google.protobuf.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];

Parameters:

value - The bytes for tuningOperation to set.

Returns:

This builder for chaining.

setUnknownFields

public final Engine.RecommendationMetadata.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder>

mergeUnknownFields

public final Engine.RecommendationMetadata.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.RecommendationMetadata.Builder>