com.google.cloud.discoveryengine.v1alpha

Class Control.BoostAction.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessageV3.Builder<Control.BoostAction.Builder>

com.google.cloud.discoveryengine.v1alpha.Control.BoostAction.Builder

All Implemented Interfaces:

Control.BoostActionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Control.BoostAction

public static final class Control.BoostAction.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Control.BoostAction.Builder>
implements Control.BoostActionOrBuilder

 Adjusts order of products in returned list.
 

Protobuf type google.cloud.discoveryengine.v1alpha.Control.BoostAction

Method Summary

Modifier and Type	Method and Description
Control.BoostAction.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Control.BoostAction	build()
Control.BoostAction	buildPartial()
Control.BoostAction.Builder	clear()
Control.BoostAction.Builder	clearBoost() Required.
Control.BoostAction.Builder	clearDataStore() Required.
Control.BoostAction.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Control.BoostAction.Builder	clearFilter() Required.
Control.BoostAction.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Control.BoostAction.Builder	clone()
float	getBoost() Required.
String	getDataStore() Required.
com.google.protobuf.ByteString	getDataStoreBytes() Required.
Control.BoostAction	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter() Required.
com.google.protobuf.ByteString	getFilterBytes() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Control.BoostAction.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Control.BoostAction.Builder	mergeFrom(Control.BoostAction other)
Control.BoostAction.Builder	mergeFrom(com.google.protobuf.Message other)
Control.BoostAction.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Control.BoostAction.Builder	setBoost(float value) Required.
Control.BoostAction.Builder	setDataStore(String value) Required.
Control.BoostAction.Builder	setDataStoreBytes(com.google.protobuf.ByteString value) Required.
Control.BoostAction.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Control.BoostAction.Builder	setFilter(String value) Required.
Control.BoostAction.Builder	setFilterBytes(com.google.protobuf.ByteString value) Required.
Control.BoostAction.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Control.BoostAction.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<Control.BoostAction.Builder>

clear

public Control.BoostAction.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<Control.BoostAction.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<Control.BoostAction.Builder>

getDefaultInstanceForType

public Control.BoostAction getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Control.BoostAction build()

Specified by:

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

Specified by:

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

buildPartial

public Control.BoostAction buildPartial()

Specified by:

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

Specified by:

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

clone

public Control.BoostAction.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<Control.BoostAction.Builder>

setField

public Control.BoostAction.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<Control.BoostAction.Builder>

clearField

public Control.BoostAction.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<Control.BoostAction.Builder>

clearOneof

public Control.BoostAction.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<Control.BoostAction.Builder>

setRepeatedField

public Control.BoostAction.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<Control.BoostAction.Builder>

addRepeatedField

public Control.BoostAction.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<Control.BoostAction.Builder>

mergeFrom

public Control.BoostAction.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<Control.BoostAction.Builder>

mergeFrom

public Control.BoostAction.Builder mergeFrom(Control.BoostAction other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Control.BoostAction.Builder>

mergeFrom

public Control.BoostAction.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<Control.BoostAction.Builder>

Throws:

IOException

getBoost

public float getBoost()

 Required. Strength of the boost, which should be in [-1, 1]. Negative
 boost means demotion. Default is 0.0 (No-op).
 

float boost = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getBoost in interface Control.BoostActionOrBuilder

Returns:

The boost.

setBoost

public Control.BoostAction.Builder setBoost(float value)

 Required. Strength of the boost, which should be in [-1, 1]. Negative
 boost means demotion. Default is 0.0 (No-op).
 

float boost = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The boost to set.

Returns:

This builder for chaining.

clearBoost

public Control.BoostAction.Builder clearBoost()

 Required. Strength of the boost, which should be in [-1, 1]. Negative
 boost means demotion. Default is 0.0 (No-op).
 

float boost = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

This builder for chaining.

getFilter

public String getFilter()

 Required. Specifies which products to apply the boost to.

 If no filter is provided all products will be boosted (No-op).
 Syntax documentation:
 https://cloud.google.com/retail/docs/filter-and-order
 Maximum length is 5000 characters.
 Otherwise an INVALID ARGUMENT error is thrown.
 

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getFilter in interface Control.BoostActionOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Required. Specifies which products to apply the boost to.

 If no filter is provided all products will be boosted (No-op).
 Syntax documentation:
 https://cloud.google.com/retail/docs/filter-and-order
 Maximum length is 5000 characters.
 Otherwise an INVALID ARGUMENT error is thrown.
 

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getFilterBytes in interface Control.BoostActionOrBuilder

Returns:

The bytes for filter.

setFilter

public Control.BoostAction.Builder setFilter(String value)

 Required. Specifies which products to apply the boost to.

 If no filter is provided all products will be boosted (No-op).
 Syntax documentation:
 https://cloud.google.com/retail/docs/filter-and-order
 Maximum length is 5000 characters.
 Otherwise an INVALID ARGUMENT error is thrown.
 

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public Control.BoostAction.Builder clearFilter()

 Required. Specifies which products to apply the boost to.

 If no filter is provided all products will be boosted (No-op).
 Syntax documentation:
 https://cloud.google.com/retail/docs/filter-and-order
 Maximum length is 5000 characters.
 Otherwise an INVALID ARGUMENT error is thrown.
 

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

This builder for chaining.

setFilterBytes

public Control.BoostAction.Builder setFilterBytes(com.google.protobuf.ByteString value)

 Required. Specifies which products to apply the boost to.

 If no filter is provided all products will be boosted (No-op).
 Syntax documentation:
 https://cloud.google.com/retail/docs/filter-and-order
 Maximum length is 5000 characters.
 Otherwise an INVALID ARGUMENT error is thrown.
 

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

getDataStore

public String getDataStore()

 Required. Specifies which data store's documents can be boosted by this
 control. Full data store name e.g.
 projects/123/locations/global/collections/default_collection/dataStores/default_data_store
 

string data_store = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getDataStore in interface Control.BoostActionOrBuilder

Returns:

The dataStore.

getDataStoreBytes

public com.google.protobuf.ByteString getDataStoreBytes()

 Required. Specifies which data store's documents can be boosted by this
 control. Full data store name e.g.
 projects/123/locations/global/collections/default_collection/dataStores/default_data_store
 

string data_store = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getDataStoreBytes in interface Control.BoostActionOrBuilder

Returns:

The bytes for dataStore.

setDataStore

public Control.BoostAction.Builder setDataStore(String value)

 Required. Specifies which data store's documents can be boosted by this
 control. Full data store name e.g.
 projects/123/locations/global/collections/default_collection/dataStores/default_data_store
 

string data_store = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:

value - The dataStore to set.

Returns:

This builder for chaining.

clearDataStore

public Control.BoostAction.Builder clearDataStore()

 Required. Specifies which data store's documents can be boosted by this
 control. Full data store name e.g.
 projects/123/locations/global/collections/default_collection/dataStores/default_data_store
 

string data_store = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

This builder for chaining.

setDataStoreBytes

public Control.BoostAction.Builder setDataStoreBytes(com.google.protobuf.ByteString value)

 Required. Specifies which data store's documents can be boosted by this
 control. Full data store name e.g.
 projects/123/locations/global/collections/default_collection/dataStores/default_data_store
 

string data_store = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:

value - The bytes for dataStore to set.

Returns:

This builder for chaining.

setUnknownFields

public final Control.BoostAction.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<Control.BoostAction.Builder>

mergeUnknownFields

public final Control.BoostAction.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<Control.BoostAction.Builder>