Class Condition.Builder (2.50.0)

public static final class Condition.Builder extends GeneratedMessageV3.Builder<Condition.Builder> implements ConditionOrBuilder

Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.

Protobuf type google.cloud.retail.v2.Condition

Implements

ConditionOrBuilder

Static Methods

getDescriptor()

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

Methods

addActiveTimeRange(Condition.TimeRange value)

public Condition.Builder addActiveTimeRange(Condition.TimeRange value)

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Parameter
Name Description
value Condition.TimeRange
Returns
Type Description
Condition.Builder

addActiveTimeRange(Condition.TimeRange.Builder builderForValue)

public Condition.Builder addActiveTimeRange(Condition.TimeRange.Builder builderForValue)

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Parameter
Name Description
builderForValue Condition.TimeRange.Builder
Returns
Type Description
Condition.Builder

addActiveTimeRange(int index, Condition.TimeRange value)

public Condition.Builder addActiveTimeRange(int index, Condition.TimeRange value)

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Parameters
Name Description
index int
value Condition.TimeRange
Returns
Type Description
Condition.Builder

addActiveTimeRange(int index, Condition.TimeRange.Builder builderForValue)

public Condition.Builder addActiveTimeRange(int index, Condition.TimeRange.Builder builderForValue)

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Parameters
Name Description
index int
builderForValue Condition.TimeRange.Builder
Returns
Type Description
Condition.Builder

addActiveTimeRangeBuilder()

public Condition.TimeRange.Builder addActiveTimeRangeBuilder()

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Returns
Type Description
Condition.TimeRange.Builder

addActiveTimeRangeBuilder(int index)

public Condition.TimeRange.Builder addActiveTimeRangeBuilder(int index)

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Parameter
Name Description
index int
Returns
Type Description
Condition.TimeRange.Builder

addAllActiveTimeRange(Iterable<? extends Condition.TimeRange> values)

public Condition.Builder addAllActiveTimeRange(Iterable<? extends Condition.TimeRange> values)

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.retail.v2.Condition.TimeRange>
Returns
Type Description
Condition.Builder

addAllPageCategories(Iterable<String> values)

public Condition.Builder addAllPageCategories(Iterable<String> values)

Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;

repeated string page_categories = 4;

Parameter
Name Description
values Iterable<String>

The pageCategories to add.

Returns
Type Description
Condition.Builder

This builder for chaining.

addAllQueryTerms(Iterable<? extends Condition.QueryTerm> values)

public Condition.Builder addAllQueryTerms(Iterable<? extends Condition.QueryTerm> values)

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Parameter
Name Description
values Iterable<? extends com.google.cloud.retail.v2.Condition.QueryTerm>
Returns
Type Description
Condition.Builder

addPageCategories(String value)

public Condition.Builder addPageCategories(String value)

Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;

repeated string page_categories = 4;

Parameter
Name Description
value String

The pageCategories to add.

Returns
Type Description
Condition.Builder

This builder for chaining.

addPageCategoriesBytes(ByteString value)

public Condition.Builder addPageCategoriesBytes(ByteString value)

Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;

repeated string page_categories = 4;

Parameter
Name Description
value ByteString

The bytes of the pageCategories to add.

Returns
Type Description
Condition.Builder

This builder for chaining.

addQueryTerms(Condition.QueryTerm value)

public Condition.Builder addQueryTerms(Condition.QueryTerm value)

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Parameter
Name Description
value Condition.QueryTerm
Returns
Type Description
Condition.Builder

addQueryTerms(Condition.QueryTerm.Builder builderForValue)

public Condition.Builder addQueryTerms(Condition.QueryTerm.Builder builderForValue)

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Parameter
Name Description
builderForValue Condition.QueryTerm.Builder
Returns
Type Description
Condition.Builder

addQueryTerms(int index, Condition.QueryTerm value)

public Condition.Builder addQueryTerms(int index, Condition.QueryTerm value)

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Parameters
Name Description
index int
value Condition.QueryTerm
Returns
Type Description
Condition.Builder

addQueryTerms(int index, Condition.QueryTerm.Builder builderForValue)

public Condition.Builder addQueryTerms(int index, Condition.QueryTerm.Builder builderForValue)

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Parameters
Name Description
index int
builderForValue Condition.QueryTerm.Builder
Returns
Type Description
Condition.Builder

addQueryTermsBuilder()

public Condition.QueryTerm.Builder addQueryTermsBuilder()

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Returns
Type Description
Condition.QueryTerm.Builder

addQueryTermsBuilder(int index)

public Condition.QueryTerm.Builder addQueryTermsBuilder(int index)

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Parameter
Name Description
index int
Returns
Type Description
Condition.QueryTerm.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Condition build()
Returns
Type Description
Condition

buildPartial()

public Condition buildPartial()
Returns
Type Description
Condition

clear()

public Condition.Builder clear()
Returns
Type Description
Condition.Builder
Overrides

clearActiveTimeRange()

public Condition.Builder clearActiveTimeRange()

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Returns
Type Description
Condition.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageCategories()

public Condition.Builder clearPageCategories()

Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;

repeated string page_categories = 4;

Returns
Type Description
Condition.Builder

This builder for chaining.

clearQueryTerms()

public Condition.Builder clearQueryTerms()

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Returns
Type Description
Condition.Builder

clone()

public Condition.Builder clone()
Returns
Type Description
Condition.Builder
Overrides

getActiveTimeRange(int index)

public Condition.TimeRange getActiveTimeRange(int index)

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Parameter
Name Description
index int
Returns
Type Description
Condition.TimeRange

getActiveTimeRangeBuilder(int index)

public Condition.TimeRange.Builder getActiveTimeRangeBuilder(int index)

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Parameter
Name Description
index int
Returns
Type Description
Condition.TimeRange.Builder

getActiveTimeRangeBuilderList()

public List<Condition.TimeRange.Builder> getActiveTimeRangeBuilderList()

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Returns
Type Description
List<Builder>

getActiveTimeRangeCount()

public int getActiveTimeRangeCount()

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Returns
Type Description
int

getActiveTimeRangeList()

public List<Condition.TimeRange> getActiveTimeRangeList()

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Returns
Type Description
List<TimeRange>

getActiveTimeRangeOrBuilder(int index)

public Condition.TimeRangeOrBuilder getActiveTimeRangeOrBuilder(int index)

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Parameter
Name Description
index int
Returns
Type Description
Condition.TimeRangeOrBuilder

getActiveTimeRangeOrBuilderList()

public List<? extends Condition.TimeRangeOrBuilder> getActiveTimeRangeOrBuilderList()

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Returns
Type Description
List<? extends com.google.cloud.retail.v2.Condition.TimeRangeOrBuilder>

getDefaultInstanceForType()

public Condition getDefaultInstanceForType()
Returns
Type Description
Condition

getDescriptorForType()

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

getPageCategories(int index)

public String getPageCategories(int index)

Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;

repeated string page_categories = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The pageCategories at the given index.

getPageCategoriesBytes(int index)

public ByteString getPageCategoriesBytes(int index)

Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;

repeated string page_categories = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the pageCategories at the given index.

getPageCategoriesCount()

public int getPageCategoriesCount()

Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;

repeated string page_categories = 4;

Returns
Type Description
int

The count of pageCategories.

getPageCategoriesList()

public ProtocolStringList getPageCategoriesList()

Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;

repeated string page_categories = 4;

Returns
Type Description
ProtocolStringList

A list containing the pageCategories.

getQueryTerms(int index)

public Condition.QueryTerm getQueryTerms(int index)

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Parameter
Name Description
index int
Returns
Type Description
Condition.QueryTerm

getQueryTermsBuilder(int index)

public Condition.QueryTerm.Builder getQueryTermsBuilder(int index)

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Parameter
Name Description
index int
Returns
Type Description
Condition.QueryTerm.Builder

getQueryTermsBuilderList()

public List<Condition.QueryTerm.Builder> getQueryTermsBuilderList()

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Returns
Type Description
List<Builder>

getQueryTermsCount()

public int getQueryTermsCount()

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Returns
Type Description
int

getQueryTermsList()

public List<Condition.QueryTerm> getQueryTermsList()

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Returns
Type Description
List<QueryTerm>

getQueryTermsOrBuilder(int index)

public Condition.QueryTermOrBuilder getQueryTermsOrBuilder(int index)

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Parameter
Name Description
index int
Returns
Type Description
Condition.QueryTermOrBuilder

getQueryTermsOrBuilderList()

public List<? extends Condition.QueryTermOrBuilder> getQueryTermsOrBuilderList()

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Returns
Type Description
List<? extends com.google.cloud.retail.v2.Condition.QueryTermOrBuilder>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Condition other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeActiveTimeRange(int index)

public Condition.Builder removeActiveTimeRange(int index)

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Parameter
Name Description
index int
Returns
Type Description
Condition.Builder

removeQueryTerms(int index)

public Condition.Builder removeQueryTerms(int index)

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Parameter
Name Description
index int
Returns
Type Description
Condition.Builder

setActiveTimeRange(int index, Condition.TimeRange value)

public Condition.Builder setActiveTimeRange(int index, Condition.TimeRange value)

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Parameters
Name Description
index int
value Condition.TimeRange
Returns
Type Description
Condition.Builder

setActiveTimeRange(int index, Condition.TimeRange.Builder builderForValue)

public Condition.Builder setActiveTimeRange(int index, Condition.TimeRange.Builder builderForValue)

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Parameters
Name Description
index int
builderForValue Condition.TimeRange.Builder
Returns
Type Description
Condition.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageCategories(int index, String value)

public Condition.Builder setPageCategories(int index, String value)

Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;

repeated string page_categories = 4;

Parameters
Name Description
index int

The index to set the value at.

value String

The pageCategories to set.

Returns
Type Description
Condition.Builder

This builder for chaining.

setQueryTerms(int index, Condition.QueryTerm value)

public Condition.Builder setQueryTerms(int index, Condition.QueryTerm value)

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Parameters
Name Description
index int
value Condition.QueryTerm
Returns
Type Description
Condition.Builder

setQueryTerms(int index, Condition.QueryTerm.Builder builderForValue)

public Condition.Builder setQueryTerms(int index, Condition.QueryTerm.Builder builderForValue)

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Parameters
Name Description
index int
builderForValue Condition.QueryTerm.Builder
Returns
Type Description
Condition.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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