Class Rule.DoNotAssociateAction.Builder (2.57.0) 

public static final class Rule.DoNotAssociateAction.Builder extends GeneratedMessageV3.Builder<Rule.DoNotAssociateAction.Builder> implements Rule.DoNotAssociateActionOrBuilder

Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".

Protobuf type google.cloud.retail.v2beta.Rule.DoNotAssociateAction

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Rule.DoNotAssociateAction.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllDoNotAssociateTerms(Iterable<String> values)

public Rule.DoNotAssociateAction.Builder addAllDoNotAssociateTerms(Iterable<String> values)

Cannot contain duplicates or the query term. Can specify up to 100 terms.

repeated string do_not_associate_terms = 3;

Parameter
Name Description
values Iterable<String>

The doNotAssociateTerms to add.
Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

addAllQueryTerms(Iterable<String> values)

public Rule.DoNotAssociateAction.Builder addAllQueryTerms(Iterable<String> values)

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameter
Name Description
values Iterable<String>

The queryTerms to add.
Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

addAllTerms(Iterable<String> values)

public Rule.DoNotAssociateAction.Builder addAllTerms(Iterable<String> values)

Will be [deprecated = true] post migration;

repeated string terms = 1;

Parameter
Name Description
values Iterable<String>

The terms to add.
Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

addDoNotAssociateTerms(String value)

public Rule.DoNotAssociateAction.Builder addDoNotAssociateTerms(String value)

Cannot contain duplicates or the query term. Can specify up to 100 terms.

repeated string do_not_associate_terms = 3;

Parameter
Name Description
value String

The doNotAssociateTerms to add.
Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

addDoNotAssociateTermsBytes(ByteString value)

public Rule.DoNotAssociateAction.Builder addDoNotAssociateTermsBytes(ByteString value)

Cannot contain duplicates or the query term. Can specify up to 100 terms.

repeated string do_not_associate_terms = 3;

Parameter
Name Description
value ByteString

The bytes of the doNotAssociateTerms to add.
Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

addQueryTerms(String value)

public Rule.DoNotAssociateAction.Builder addQueryTerms(String value)

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameter
Name Description
value String

The queryTerms to add.
Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

addQueryTermsBytes(ByteString value)

public Rule.DoNotAssociateAction.Builder addQueryTermsBytes(ByteString value)

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameter
Name Description
value ByteString

The bytes of the queryTerms to add.
Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Rule.DoNotAssociateAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Rule.DoNotAssociateAction.Builder
Overrides

addTerms(String value)

public Rule.DoNotAssociateAction.Builder addTerms(String value)

Will be [deprecated = true] post migration;

repeated string terms = 1;

Parameter
Name Description
value String

The terms to add.
Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

addTermsBytes(ByteString value)

public Rule.DoNotAssociateAction.Builder addTermsBytes(ByteString value)

Will be [deprecated = true] post migration;

repeated string terms = 1;

Parameter
Name Description
value ByteString

The bytes of the terms to add.
Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

build()

public Rule.DoNotAssociateAction build()
Returns
Type Description
Rule.DoNotAssociateAction

buildPartial()

public Rule.DoNotAssociateAction buildPartial()
Returns
Type Description
Rule.DoNotAssociateAction

clear()

public Rule.DoNotAssociateAction.Builder clear()
Returns
Type Description
Rule.DoNotAssociateAction.Builder
Overrides

clearDoNotAssociateTerms()

public Rule.DoNotAssociateAction.Builder clearDoNotAssociateTerms()

Cannot contain duplicates or the query term. Can specify up to 100 terms.

repeated string do_not_associate_terms = 3;

Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Rule.DoNotAssociateAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Rule.DoNotAssociateAction.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Rule.DoNotAssociateAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Rule.DoNotAssociateAction.Builder
Overrides

clearQueryTerms()

public Rule.DoNotAssociateAction.Builder clearQueryTerms()

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

repeated string query_terms = 2;

Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

clearTerms()

public Rule.DoNotAssociateAction.Builder clearTerms()

Will be [deprecated = true] post migration;

repeated string terms = 1;

Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

clone()

public Rule.DoNotAssociateAction.Builder clone()
Returns
Type Description
Rule.DoNotAssociateAction.Builder
Overrides

getDefaultInstanceForType()

public Rule.DoNotAssociateAction getDefaultInstanceForType()
Returns
Type Description
Rule.DoNotAssociateAction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDoNotAssociateTerms(int index)

public String getDoNotAssociateTerms(int index)

Cannot contain duplicates or the query term. Can specify up to 100 terms.

repeated string do_not_associate_terms = 3;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The doNotAssociateTerms at the given index.

getDoNotAssociateTermsBytes(int index)

public ByteString getDoNotAssociateTermsBytes(int index)

Cannot contain duplicates or the query term. Can specify up to 100 terms.

repeated string do_not_associate_terms = 3;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the doNotAssociateTerms at the given index.

getDoNotAssociateTermsCount()

public int getDoNotAssociateTermsCount()

Cannot contain duplicates or the query term. Can specify up to 100 terms.

repeated string do_not_associate_terms = 3;

Returns
Type Description
int

The count of doNotAssociateTerms.

getDoNotAssociateTermsList()

public ProtocolStringList getDoNotAssociateTermsList()

Cannot contain duplicates or the query term. Can specify up to 100 terms.

repeated string do_not_associate_terms = 3;

Returns
Type Description
ProtocolStringList

A list containing the doNotAssociateTerms.

getQueryTerms(int index)

public String getQueryTerms(int index)

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The queryTerms at the given index.

getQueryTermsBytes(int index)

public ByteString getQueryTermsBytes(int index)

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the queryTerms at the given index.

getQueryTermsCount()

public int getQueryTermsCount()

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

repeated string query_terms = 2;

Returns
Type Description
int

The count of queryTerms.

getQueryTermsList()

public ProtocolStringList getQueryTermsList()

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

repeated string query_terms = 2;

Returns
Type Description
ProtocolStringList

A list containing the queryTerms.

getTerms(int index)

public String getTerms(int index)

Will be [deprecated = true] post migration;

repeated string terms = 1;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The terms at the given index.

getTermsBytes(int index)

public ByteString getTermsBytes(int index)

Will be [deprecated = true] post migration;

repeated string terms = 1;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the terms at the given index.

getTermsCount()

public int getTermsCount()

Will be [deprecated = true] post migration;

repeated string terms = 1;

Returns
Type Description
int

The count of terms.

getTermsList()

public ProtocolStringList getTermsList()

Will be [deprecated = true] post migration;

repeated string terms = 1;

Returns
Type Description
ProtocolStringList

A list containing the terms.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Rule.DoNotAssociateAction other)

public Rule.DoNotAssociateAction.Builder mergeFrom(Rule.DoNotAssociateAction other)
Parameter
Name Description
other Rule.DoNotAssociateAction
Returns
Type Description
Rule.DoNotAssociateAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Rule.DoNotAssociateAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.DoNotAssociateAction.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Rule.DoNotAssociateAction.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Rule.DoNotAssociateAction.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Rule.DoNotAssociateAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Rule.DoNotAssociateAction.Builder
Overrides

setDoNotAssociateTerms(int index, String value)

public Rule.DoNotAssociateAction.Builder setDoNotAssociateTerms(int index, String value)

Cannot contain duplicates or the query term. Can specify up to 100 terms.

repeated string do_not_associate_terms = 3;

Parameters
Name Description
index int

The index to set the value at.
value String

The doNotAssociateTerms to set.
Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Rule.DoNotAssociateAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Rule.DoNotAssociateAction.Builder
Overrides

setQueryTerms(int index, String value)

public Rule.DoNotAssociateAction.Builder setQueryTerms(int index, String value)

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

repeated string query_terms = 2;

Parameters
Name Description
index int

The index to set the value at.
value String

The queryTerms to set.
Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

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

public Rule.DoNotAssociateAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Rule.DoNotAssociateAction.Builder
Overrides

setTerms(int index, String value)

public Rule.DoNotAssociateAction.Builder setTerms(int index, String value)

Will be [deprecated = true] post migration;

repeated string terms = 1;

Parameters
Name Description
index int

The index to set the value at.
value String

The terms to set.
Returns
Type Description
Rule.DoNotAssociateAction.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Rule.DoNotAssociateAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Rule.DoNotAssociateAction.Builder
Overrides