public static final class CompleteQueryResponse.CompletionResult.Builder extends GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder> implements CompleteQueryResponse.CompletionResultOrBuilder
Resource that represents completion results.
Protobuf type google.cloud.retail.v2alpha.CompleteQueryResponse.CompletionResult
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addAllFacets(Iterable<? extends SearchResponse.Facet> values)
public CompleteQueryResponse.CompletionResult.Builder addAllFacets(Iterable<? extends SearchResponse.Facet> values)
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
| Parameter |
|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.retail.v2alpha.SearchResponse.Facet>
|
addFacets(SearchResponse.Facet value)
public CompleteQueryResponse.CompletionResult.Builder addFacets(SearchResponse.Facet value)
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
addFacets(SearchResponse.Facet.Builder builderForValue)
public CompleteQueryResponse.CompletionResult.Builder addFacets(SearchResponse.Facet.Builder builderForValue)
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
addFacets(int index, SearchResponse.Facet value)
public CompleteQueryResponse.CompletionResult.Builder addFacets(int index, SearchResponse.Facet value)
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
addFacets(int index, SearchResponse.Facet.Builder builderForValue)
public CompleteQueryResponse.CompletionResult.Builder addFacets(int index, SearchResponse.Facet.Builder builderForValue)
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
addFacetsBuilder()
public SearchResponse.Facet.Builder addFacetsBuilder()
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
addFacetsBuilder(int index)
public SearchResponse.Facet.Builder addFacetsBuilder(int index)
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CompleteQueryResponse.CompletionResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public CompleteQueryResponse.CompletionResult build()
buildPartial()
public CompleteQueryResponse.CompletionResult buildPartial()
clear()
public CompleteQueryResponse.CompletionResult.Builder clear()
Overrides
clearAttributes()
public CompleteQueryResponse.CompletionResult.Builder clearAttributes()
clearFacets()
public CompleteQueryResponse.CompletionResult.Builder clearFacets()
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
clearField(Descriptors.FieldDescriptor field)
public CompleteQueryResponse.CompletionResult.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public CompleteQueryResponse.CompletionResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearSuggestion()
public CompleteQueryResponse.CompletionResult.Builder clearSuggestion()
The suggestion for the query.
string suggestion = 1;
clearTotalProductCount()
public CompleteQueryResponse.CompletionResult.Builder clearTotalProductCount()
Total number of products associated with a search with this suggestion.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
int32 total_product_count = 4;
clone()
public CompleteQueryResponse.CompletionResult.Builder clone()
Overrides
containsAttributes(String key)
public boolean containsAttributes(String key)
Custom attributes for the suggestion term.
- For "user-data", the attributes are additional custom attributes
ingested through BigQuery.
- For "cloud-retail", the attributes are product attributes generated
by Cloud Retail. It requires
UserEvent.product_details
is imported properly.
map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;
| Parameter |
|---|
| Name | Description |
key | String
|
getAttributes()
public Map<String,CustomAttribute> getAttributes()
getAttributesCount()
public int getAttributesCount()
Custom attributes for the suggestion term.
- For "user-data", the attributes are additional custom attributes
ingested through BigQuery.
- For "cloud-retail", the attributes are product attributes generated
by Cloud Retail. It requires
UserEvent.product_details
is imported properly.
map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;
| Returns |
|---|
| Type | Description |
int | |
getAttributesMap()
public Map<String,CustomAttribute> getAttributesMap()
Custom attributes for the suggestion term.
- For "user-data", the attributes are additional custom attributes
ingested through BigQuery.
- For "cloud-retail", the attributes are product attributes generated
by Cloud Retail. It requires
UserEvent.product_details
is imported properly.
map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;
getAttributesOrDefault(String key, CustomAttribute defaultValue)
public CustomAttribute getAttributesOrDefault(String key, CustomAttribute defaultValue)
Custom attributes for the suggestion term.
- For "user-data", the attributes are additional custom attributes
ingested through BigQuery.
- For "cloud-retail", the attributes are product attributes generated
by Cloud Retail. It requires
UserEvent.product_details
is imported properly.
map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;
getAttributesOrThrow(String key)
public CustomAttribute getAttributesOrThrow(String key)
Custom attributes for the suggestion term.
- For "user-data", the attributes are additional custom attributes
ingested through BigQuery.
- For "cloud-retail", the attributes are product attributes generated
by Cloud Retail. It requires
UserEvent.product_details
is imported properly.
map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;
| Parameter |
|---|
| Name | Description |
key | String
|
getDefaultInstanceForType()
public CompleteQueryResponse.CompletionResult getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getFacets(int index)
public SearchResponse.Facet getFacets(int index)
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getFacetsBuilder(int index)
public SearchResponse.Facet.Builder getFacetsBuilder(int index)
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getFacetsBuilderList()
public List<SearchResponse.Facet.Builder> getFacetsBuilderList()
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
getFacetsCount()
public int getFacetsCount()
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
| Returns |
|---|
| Type | Description |
int | |
getFacetsList()
public List<SearchResponse.Facet> getFacetsList()
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
getFacetsOrBuilder(int index)
public SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getFacetsOrBuilderList()
public List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2alpha.SearchResponse.FacetOrBuilder> | |
getMutableAttributes()
public Map<String,CustomAttribute> getMutableAttributes()
Use alternate mutation accessors instead.
getSuggestion()
public String getSuggestion()
The suggestion for the query.
string suggestion = 1;
| Returns |
|---|
| Type | Description |
String | The suggestion.
|
getSuggestionBytes()
public ByteString getSuggestionBytes()
The suggestion for the query.
string suggestion = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for suggestion.
|
getTotalProductCount()
public int getTotalProductCount()
Total number of products associated with a search with this suggestion.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
int32 total_product_count = 4;
| Returns |
|---|
| Type | Description |
int | The totalProductCount.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(CompleteQueryResponse.CompletionResult other)
public CompleteQueryResponse.CompletionResult.Builder mergeFrom(CompleteQueryResponse.CompletionResult other)
public CompleteQueryResponse.CompletionResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public CompleteQueryResponse.CompletionResult.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CompleteQueryResponse.CompletionResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
putAllAttributes(Map<String,CustomAttribute> values)
public CompleteQueryResponse.CompletionResult.Builder putAllAttributes(Map<String,CustomAttribute> values)
Custom attributes for the suggestion term.
- For "user-data", the attributes are additional custom attributes
ingested through BigQuery.
- For "cloud-retail", the attributes are product attributes generated
by Cloud Retail. It requires
UserEvent.product_details
is imported properly.
map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;
putAttributes(String key, CustomAttribute value)
public CompleteQueryResponse.CompletionResult.Builder putAttributes(String key, CustomAttribute value)
Custom attributes for the suggestion term.
- For "user-data", the attributes are additional custom attributes
ingested through BigQuery.
- For "cloud-retail", the attributes are product attributes generated
by Cloud Retail. It requires
UserEvent.product_details
is imported properly.
map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;
removeAttributes(String key)
public CompleteQueryResponse.CompletionResult.Builder removeAttributes(String key)
Custom attributes for the suggestion term.
- For "user-data", the attributes are additional custom attributes
ingested through BigQuery.
- For "cloud-retail", the attributes are product attributes generated
by Cloud Retail. It requires
UserEvent.product_details
is imported properly.
map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;
| Parameter |
|---|
| Name | Description |
key | String
|
removeFacets(int index)
public CompleteQueryResponse.CompletionResult.Builder removeFacets(int index)
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
setFacets(int index, SearchResponse.Facet value)
public CompleteQueryResponse.CompletionResult.Builder setFacets(int index, SearchResponse.Facet value)
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
setFacets(int index, SearchResponse.Facet.Builder builderForValue)
public CompleteQueryResponse.CompletionResult.Builder setFacets(int index, SearchResponse.Facet.Builder builderForValue)
Facet information for the suggestion term. Gives the number of items
resulting from a search with this suggestion term for each facet.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;
setField(Descriptors.FieldDescriptor field, Object value)
public CompleteQueryResponse.CompletionResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CompleteQueryResponse.CompletionResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setSuggestion(String value)
public CompleteQueryResponse.CompletionResult.Builder setSuggestion(String value)
The suggestion for the query.
string suggestion = 1;
| Parameter |
|---|
| Name | Description |
value | String
The suggestion to set.
|
setSuggestionBytes(ByteString value)
public CompleteQueryResponse.CompletionResult.Builder setSuggestionBytes(ByteString value)
The suggestion for the query.
string suggestion = 1;
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for suggestion to set.
|
setTotalProductCount(int value)
public CompleteQueryResponse.CompletionResult.Builder setTotalProductCount(int value)
Total number of products associated with a search with this suggestion.
This is an experimental feature for limited customers. Please reach out
to the support team if you would like to receive this information.
int32 total_product_count = 4;
| Parameter |
|---|
| Name | Description |
value | int
The totalProductCount to set.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CompleteQueryResponse.CompletionResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
