Class SearchConfig.Builder (0.4.0)

public static final class SearchConfig.Builder extends GeneratedMessageV3.Builder<SearchConfig.Builder> implements SearchConfigOrBuilder

SearchConfig stores different properties that will affect search behaviors and search results.

Protobuf type google.cloud.visionai.v1.SearchConfig

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SearchConfig build()
Returns
Type Description
SearchConfig

buildPartial()

public SearchConfig buildPartial()
Returns
Type Description
SearchConfig

clear()

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

clearFacetProperty()

public SearchConfig.Builder clearFacetProperty()

Establishes a FacetDimension and associated specifications.

.google.cloud.visionai.v1.FacetProperty facet_property = 2;

Returns
Type Description
SearchConfig.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public SearchConfig.Builder clearName()

Resource name of the search configuration. For CustomSearchCriteria, search_config would be the search operator name. For Facets, search_config would be the facet dimension name. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

string name = 1;

Returns
Type Description
SearchConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSearchCriteriaProperty()

public SearchConfig.Builder clearSearchCriteriaProperty()

Creates a mapping between a custom SearchCriteria and one or more UGA keys.

.google.cloud.visionai.v1.SearchCriteriaProperty search_criteria_property = 3;

Returns
Type Description
SearchConfig.Builder

clone()

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

getDefaultInstanceForType()

public SearchConfig getDefaultInstanceForType()
Returns
Type Description
SearchConfig

getDescriptorForType()

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

getFacetProperty()

public FacetProperty getFacetProperty()

Establishes a FacetDimension and associated specifications.

.google.cloud.visionai.v1.FacetProperty facet_property = 2;

Returns
Type Description
FacetProperty

The facetProperty.

getFacetPropertyBuilder()

public FacetProperty.Builder getFacetPropertyBuilder()

Establishes a FacetDimension and associated specifications.

.google.cloud.visionai.v1.FacetProperty facet_property = 2;

Returns
Type Description
FacetProperty.Builder

getFacetPropertyOrBuilder()

public FacetPropertyOrBuilder getFacetPropertyOrBuilder()

Establishes a FacetDimension and associated specifications.

.google.cloud.visionai.v1.FacetProperty facet_property = 2;

Returns
Type Description
FacetPropertyOrBuilder

getName()

public String getName()

Resource name of the search configuration. For CustomSearchCriteria, search_config would be the search operator name. For Facets, search_config would be the facet dimension name. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Resource name of the search configuration. For CustomSearchCriteria, search_config would be the search operator name. For Facets, search_config would be the facet dimension name. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getSearchCriteriaProperty()

public SearchCriteriaProperty getSearchCriteriaProperty()

Creates a mapping between a custom SearchCriteria and one or more UGA keys.

.google.cloud.visionai.v1.SearchCriteriaProperty search_criteria_property = 3;

Returns
Type Description
SearchCriteriaProperty

The searchCriteriaProperty.

getSearchCriteriaPropertyBuilder()

public SearchCriteriaProperty.Builder getSearchCriteriaPropertyBuilder()

Creates a mapping between a custom SearchCriteria and one or more UGA keys.

.google.cloud.visionai.v1.SearchCriteriaProperty search_criteria_property = 3;

Returns
Type Description
SearchCriteriaProperty.Builder

getSearchCriteriaPropertyOrBuilder()

public SearchCriteriaPropertyOrBuilder getSearchCriteriaPropertyOrBuilder()

Creates a mapping between a custom SearchCriteria and one or more UGA keys.

.google.cloud.visionai.v1.SearchCriteriaProperty search_criteria_property = 3;

Returns
Type Description
SearchCriteriaPropertyOrBuilder

hasFacetProperty()

public boolean hasFacetProperty()

Establishes a FacetDimension and associated specifications.

.google.cloud.visionai.v1.FacetProperty facet_property = 2;

Returns
Type Description
boolean

Whether the facetProperty field is set.

hasSearchCriteriaProperty()

public boolean hasSearchCriteriaProperty()

Creates a mapping between a custom SearchCriteria and one or more UGA keys.

.google.cloud.visionai.v1.SearchCriteriaProperty search_criteria_property = 3;

Returns
Type Description
boolean

Whether the searchCriteriaProperty field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFacetProperty(FacetProperty value)

public SearchConfig.Builder mergeFacetProperty(FacetProperty value)

Establishes a FacetDimension and associated specifications.

.google.cloud.visionai.v1.FacetProperty facet_property = 2;

Parameter
Name Description
value FacetProperty
Returns
Type Description
SearchConfig.Builder

mergeFrom(SearchConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeSearchCriteriaProperty(SearchCriteriaProperty value)

public SearchConfig.Builder mergeSearchCriteriaProperty(SearchCriteriaProperty value)

Creates a mapping between a custom SearchCriteria and one or more UGA keys.

.google.cloud.visionai.v1.SearchCriteriaProperty search_criteria_property = 3;

Parameter
Name Description
value SearchCriteriaProperty
Returns
Type Description
SearchConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setFacetProperty(FacetProperty value)

public SearchConfig.Builder setFacetProperty(FacetProperty value)

Establishes a FacetDimension and associated specifications.

.google.cloud.visionai.v1.FacetProperty facet_property = 2;

Parameter
Name Description
value FacetProperty
Returns
Type Description
SearchConfig.Builder

setFacetProperty(FacetProperty.Builder builderForValue)

public SearchConfig.Builder setFacetProperty(FacetProperty.Builder builderForValue)

Establishes a FacetDimension and associated specifications.

.google.cloud.visionai.v1.FacetProperty facet_property = 2;

Parameter
Name Description
builderForValue FacetProperty.Builder
Returns
Type Description
SearchConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public SearchConfig.Builder setName(String value)

Resource name of the search configuration. For CustomSearchCriteria, search_config would be the search operator name. For Facets, search_config would be the facet dimension name. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
SearchConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SearchConfig.Builder setNameBytes(ByteString value)

Resource name of the search configuration. For CustomSearchCriteria, search_config would be the search operator name. For Facets, search_config would be the facet dimension name. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
SearchConfig.Builder

This builder for chaining.

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

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

setSearchCriteriaProperty(SearchCriteriaProperty value)

public SearchConfig.Builder setSearchCriteriaProperty(SearchCriteriaProperty value)

Creates a mapping between a custom SearchCriteria and one or more UGA keys.

.google.cloud.visionai.v1.SearchCriteriaProperty search_criteria_property = 3;

Parameter
Name Description
value SearchCriteriaProperty
Returns
Type Description
SearchConfig.Builder

setSearchCriteriaProperty(SearchCriteriaProperty.Builder builderForValue)

public SearchConfig.Builder setSearchCriteriaProperty(SearchCriteriaProperty.Builder builderForValue)

Creates a mapping between a custom SearchCriteria and one or more UGA keys.

.google.cloud.visionai.v1.SearchCriteriaProperty search_criteria_property = 3;

Parameter
Name Description
builderForValue SearchCriteriaProperty.Builder
Returns
Type Description
SearchConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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