Class SearchConfig (0.5.0) 

public final class SearchConfig extends GeneratedMessageV3 implements SearchConfigOrBuilder

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

Protobuf type google.cloud.visionai.v1.SearchConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchConfig

Static Fields

FACET_PROPERTY_FIELD_NUMBER

public static final int FACET_PROPERTY_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SEARCH_CRITERIA_PROPERTY_FIELD_NUMBER

public static final int SEARCH_CRITERIA_PROPERTY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchConfig getDefaultInstance()
Returns
Type Description
SearchConfig

getDescriptor()

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

newBuilder()

public static SearchConfig.Builder newBuilder()
Returns
Type Description
SearchConfig.Builder

newBuilder(SearchConfig prototype)

public static SearchConfig.Builder newBuilder(SearchConfig prototype)
Parameter
Name Description
prototype SearchConfig
Returns
Type Description
SearchConfig.Builder

parseDelimitedFrom(InputStream input)

public static SearchConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchConfig> parser()
Returns
Type Description
Parser<SearchConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchConfig getDefaultInstanceForType()
Returns
Type Description
SearchConfig

getFacetProperty()

public FacetProperty getFacetProperty()

Establishes a FacetDimension and associated specifications.

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

Returns
Type Description
FacetProperty

The facetProperty.

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.

getParserForType()

public Parser<SearchConfig> getParserForType()
Returns
Type Description
Parser<SearchConfig>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchConfig.Builder newBuilderForType()
Returns
Type Description
SearchConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchConfig.Builder toBuilder()
Returns
Type Description
SearchConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException