Class SearchRequest.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
-
- com.google.cloud.enterpriseknowledgegraph.v1.SearchRequest.Builder
-
- All Implemented Interfaces:
SearchRequestOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- SearchRequest
public static final class SearchRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder> implements SearchRequestOrBuilder
Request message for [EnterpriseKnowledgeGraphService.Search][google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.Search].
Protobuf typegoogle.cloud.enterpriseknowledgegraph.v1.SearchRequest
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SearchRequest.BuilderaddAllLanguages(Iterable<String> values)The list of language codes (defined in ISO 693) to run the query with, e.g.SearchRequest.BuilderaddAllTypes(Iterable<String> values)Restricts returned entities with these types, e.g.SearchRequest.BuilderaddLanguages(String value)The list of language codes (defined in ISO 693) to run the query with, e.g.SearchRequest.BuilderaddLanguagesBytes(com.google.protobuf.ByteString value)The list of language codes (defined in ISO 693) to run the query with, e.g.SearchRequest.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)SearchRequest.BuilderaddTypes(String value)Restricts returned entities with these types, e.g.SearchRequest.BuilderaddTypesBytes(com.google.protobuf.ByteString value)Restricts returned entities with these types, e.g.SearchRequestbuild()SearchRequestbuildPartial()SearchRequest.Builderclear()SearchRequest.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)SearchRequest.BuilderclearLanguages()The list of language codes (defined in ISO 693) to run the query with, e.g.SearchRequest.BuilderclearLimit()Limits the number of entities to be returned.SearchRequest.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)SearchRequest.BuilderclearParent()Required.SearchRequest.BuilderclearQuery()Required.SearchRequest.BuilderclearTypes()Restricts returned entities with these types, e.g.SearchRequest.Builderclone()SearchRequestgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()StringgetLanguages(int index)The list of language codes (defined in ISO 693) to run the query with, e.g.com.google.protobuf.ByteStringgetLanguagesBytes(int index)The list of language codes (defined in ISO 693) to run the query with, e.g.intgetLanguagesCount()The list of language codes (defined in ISO 693) to run the query with, e.g.com.google.protobuf.ProtocolStringListgetLanguagesList()The list of language codes (defined in ISO 693) to run the query with, e.g.com.google.protobuf.Int32ValuegetLimit()Limits the number of entities to be returned.com.google.protobuf.Int32Value.BuildergetLimitBuilder()Limits the number of entities to be returned.com.google.protobuf.Int32ValueOrBuildergetLimitOrBuilder()Limits the number of entities to be returned.StringgetParent()Required.com.google.protobuf.ByteStringgetParentBytes()Required.StringgetQuery()Required.com.google.protobuf.ByteStringgetQueryBytes()Required.StringgetTypes(int index)Restricts returned entities with these types, e.g.com.google.protobuf.ByteStringgetTypesBytes(int index)Restricts returned entities with these types, e.g.intgetTypesCount()Restricts returned entities with these types, e.g.com.google.protobuf.ProtocolStringListgetTypesList()Restricts returned entities with these types, e.g.booleanhasLimit()Limits the number of entities to be returned.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()SearchRequest.BuildermergeFrom(SearchRequest other)SearchRequest.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)SearchRequest.BuildermergeFrom(com.google.protobuf.Message other)SearchRequest.BuildermergeLimit(com.google.protobuf.Int32Value value)Limits the number of entities to be returned.SearchRequest.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)SearchRequest.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)SearchRequest.BuildersetLanguages(int index, String value)The list of language codes (defined in ISO 693) to run the query with, e.g.SearchRequest.BuildersetLimit(com.google.protobuf.Int32Value value)Limits the number of entities to be returned.SearchRequest.BuildersetLimit(com.google.protobuf.Int32Value.Builder builderForValue)Limits the number of entities to be returned.SearchRequest.BuildersetParent(String value)Required.SearchRequest.BuildersetParentBytes(com.google.protobuf.ByteString value)Required.SearchRequest.BuildersetQuery(String value)Required.SearchRequest.BuildersetQueryBytes(com.google.protobuf.ByteString value)Required.SearchRequest.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)SearchRequest.BuildersetTypes(int index, String value)Restricts returned entities with these types, e.g.SearchRequest.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
-
clear
public SearchRequest.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
-
getDefaultInstanceForType
public SearchRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public SearchRequest build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public SearchRequest buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public SearchRequest.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
-
setField
public SearchRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
-
clearField
public SearchRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
-
clearOneof
public SearchRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
-
setRepeatedField
public SearchRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
-
addRepeatedField
public SearchRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
-
mergeFrom
public SearchRequest.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchRequest.Builder>
-
mergeFrom
public SearchRequest.Builder mergeFrom(SearchRequest other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
-
mergeFrom
public SearchRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchRequest.Builder>- Throws:
IOException
-
getParent
public String getParent()
Required. The name of the Entity's parent resource. Format: `projects/{project}/locations/{location}`string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Specified by:
getParentin interfaceSearchRequestOrBuilder- Returns:
- The parent.
-
getParentBytes
public com.google.protobuf.ByteString getParentBytes()
Required. The name of the Entity's parent resource. Format: `projects/{project}/locations/{location}`string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Specified by:
getParentBytesin interfaceSearchRequestOrBuilder- Returns:
- The bytes for parent.
-
setParent
public SearchRequest.Builder setParent(String value)
Required. The name of the Entity's parent resource. Format: `projects/{project}/locations/{location}`string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Parameters:
value- The parent to set.- Returns:
- This builder for chaining.
-
clearParent
public SearchRequest.Builder clearParent()
Required. The name of the Entity's parent resource. Format: `projects/{project}/locations/{location}`string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Returns:
- This builder for chaining.
-
setParentBytes
public SearchRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
Required. The name of the Entity's parent resource. Format: `projects/{project}/locations/{location}`string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Parameters:
value- The bytes for parent to set.- Returns:
- This builder for chaining.
-
getQuery
public String getQuery()
Required. The literal query string for search.
string query = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getQueryin interfaceSearchRequestOrBuilder- Returns:
- The query.
-
getQueryBytes
public com.google.protobuf.ByteString getQueryBytes()
Required. The literal query string for search.
string query = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getQueryBytesin interfaceSearchRequestOrBuilder- Returns:
- The bytes for query.
-
setQuery
public SearchRequest.Builder setQuery(String value)
Required. The literal query string for search.
string query = 2 [(.google.api.field_behavior) = REQUIRED];- Parameters:
value- The query to set.- Returns:
- This builder for chaining.
-
clearQuery
public SearchRequest.Builder clearQuery()
Required. The literal query string for search.
string query = 2 [(.google.api.field_behavior) = REQUIRED];- Returns:
- This builder for chaining.
-
setQueryBytes
public SearchRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)
Required. The literal query string for search.
string query = 2 [(.google.api.field_behavior) = REQUIRED];- Parameters:
value- The bytes for query to set.- Returns:
- This builder for chaining.
-
getLanguagesList
public com.google.protobuf.ProtocolStringList getLanguagesList()
The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.
repeated string languages = 3;- Specified by:
getLanguagesListin interfaceSearchRequestOrBuilder- Returns:
- A list containing the languages.
-
getLanguagesCount
public int getLanguagesCount()
The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.
repeated string languages = 3;- Specified by:
getLanguagesCountin interfaceSearchRequestOrBuilder- Returns:
- The count of languages.
-
getLanguages
public String getLanguages(int index)
The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.
repeated string languages = 3;- Specified by:
getLanguagesin interfaceSearchRequestOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The languages at the given index.
-
getLanguagesBytes
public com.google.protobuf.ByteString getLanguagesBytes(int index)
The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.
repeated string languages = 3;- Specified by:
getLanguagesBytesin interfaceSearchRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the languages at the given index.
-
setLanguages
public SearchRequest.Builder setLanguages(int index, String value)
The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.
repeated string languages = 3;- Parameters:
index- The index to set the value at.value- The languages to set.- Returns:
- This builder for chaining.
-
addLanguages
public SearchRequest.Builder addLanguages(String value)
The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.
repeated string languages = 3;- Parameters:
value- The languages to add.- Returns:
- This builder for chaining.
-
addAllLanguages
public SearchRequest.Builder addAllLanguages(Iterable<String> values)
The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.
repeated string languages = 3;- Parameters:
values- The languages to add.- Returns:
- This builder for chaining.
-
clearLanguages
public SearchRequest.Builder clearLanguages()
The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.
repeated string languages = 3;- Returns:
- This builder for chaining.
-
addLanguagesBytes
public SearchRequest.Builder addLanguagesBytes(com.google.protobuf.ByteString value)
The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.
repeated string languages = 3;- Parameters:
value- The bytes of the languages to add.- Returns:
- This builder for chaining.
-
getTypesList
public com.google.protobuf.ProtocolStringList getTypesList()
Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.
repeated string types = 4;- Specified by:
getTypesListin interfaceSearchRequestOrBuilder- Returns:
- A list containing the types.
-
getTypesCount
public int getTypesCount()
Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.
repeated string types = 4;- Specified by:
getTypesCountin interfaceSearchRequestOrBuilder- Returns:
- The count of types.
-
getTypes
public String getTypes(int index)
Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.
repeated string types = 4;- Specified by:
getTypesin interfaceSearchRequestOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The types at the given index.
-
getTypesBytes
public com.google.protobuf.ByteString getTypesBytes(int index)
Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.
repeated string types = 4;- Specified by:
getTypesBytesin interfaceSearchRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the types at the given index.
-
setTypes
public SearchRequest.Builder setTypes(int index, String value)
Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.
repeated string types = 4;- Parameters:
index- The index to set the value at.value- The types to set.- Returns:
- This builder for chaining.
-
addTypes
public SearchRequest.Builder addTypes(String value)
Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.
repeated string types = 4;- Parameters:
value- The types to add.- Returns:
- This builder for chaining.
-
addAllTypes
public SearchRequest.Builder addAllTypes(Iterable<String> values)
Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.
repeated string types = 4;- Parameters:
values- The types to add.- Returns:
- This builder for chaining.
-
clearTypes
public SearchRequest.Builder clearTypes()
Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.
repeated string types = 4;- Returns:
- This builder for chaining.
-
addTypesBytes
public SearchRequest.Builder addTypesBytes(com.google.protobuf.ByteString value)
Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.
repeated string types = 4;- Parameters:
value- The bytes of the types to add.- Returns:
- This builder for chaining.
-
hasLimit
public boolean hasLimit()
Limits the number of entities to be returned.
.google.protobuf.Int32Value limit = 6;- Specified by:
hasLimitin interfaceSearchRequestOrBuilder- Returns:
- Whether the limit field is set.
-
getLimit
public com.google.protobuf.Int32Value getLimit()
Limits the number of entities to be returned.
.google.protobuf.Int32Value limit = 6;- Specified by:
getLimitin interfaceSearchRequestOrBuilder- Returns:
- The limit.
-
setLimit
public SearchRequest.Builder setLimit(com.google.protobuf.Int32Value value)
Limits the number of entities to be returned.
.google.protobuf.Int32Value limit = 6;
-
setLimit
public SearchRequest.Builder setLimit(com.google.protobuf.Int32Value.Builder builderForValue)
Limits the number of entities to be returned.
.google.protobuf.Int32Value limit = 6;
-
mergeLimit
public SearchRequest.Builder mergeLimit(com.google.protobuf.Int32Value value)
Limits the number of entities to be returned.
.google.protobuf.Int32Value limit = 6;
-
clearLimit
public SearchRequest.Builder clearLimit()
Limits the number of entities to be returned.
.google.protobuf.Int32Value limit = 6;
-
getLimitBuilder
public com.google.protobuf.Int32Value.Builder getLimitBuilder()
Limits the number of entities to be returned.
.google.protobuf.Int32Value limit = 6;
-
getLimitOrBuilder
public com.google.protobuf.Int32ValueOrBuilder getLimitOrBuilder()
Limits the number of entities to be returned.
.google.protobuf.Int32Value limit = 6;- Specified by:
getLimitOrBuilderin interfaceSearchRequestOrBuilder
-
setUnknownFields
public final SearchRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
-
mergeUnknownFields
public final SearchRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
-
-