Class SearchRequest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.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.GeneratedMessage.Builder<SearchRequest.Builder>
implements SearchRequestOrBuilder
Request message for [EnterpriseKnowledgeGraphService.Search][google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.Search].Protobuf type
google.cloud.enterpriseknowledgegraph.v1.SearchRequest-
Method Summary
Modifier and TypeMethodDescriptionaddAllLanguages(Iterable<String> values) The list of language codes (defined in ISO 693) to run the query with, e.g.addAllTypes(Iterable<String> values) Restricts returned entities with these types, e.g.addLanguages(String value) The list of language codes (defined in ISO 693) to run the query with, e.g.addLanguagesBytes(com.google.protobuf.ByteString value) The list of language codes (defined in ISO 693) to run the query with, e.g.Restricts returned entities with these types, e.g.addTypesBytes(com.google.protobuf.ByteString value) Restricts returned entities with these types, e.g.build()clear()The list of language codes (defined in ISO 693) to run the query with, e.g.Limits the number of entities to be returned.Required.Required.Restricts returned entities with these types, e.g.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorgetLanguages(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.intThe list of language codes (defined in ISO 693) to run the query with, e.g.com.google.protobuf.ProtocolStringListThe 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.BuilderLimits the number of entities to be returned.com.google.protobuf.Int32ValueOrBuilderLimits the number of entities to be returned.Required.com.google.protobuf.ByteStringRequired.getQuery()Required.com.google.protobuf.ByteStringRequired.getTypes(int index) Restricts returned entities with these types, e.g.com.google.protobuf.ByteStringgetTypesBytes(int index) Restricts returned entities with these types, e.g.intRestricts returned entities with these types, e.g.com.google.protobuf.ProtocolStringListRestricts returned entities with these types, e.g.booleanhasLimit()Limits the number of entities to be returned.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(SearchRequest other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeLimit(com.google.protobuf.Int32Value value) Limits the number of entities to be returned.setLanguages(int index, String value) The list of language codes (defined in ISO 693) to run the query with, e.g.setLimit(com.google.protobuf.Int32Value value) Limits the number of entities to be returned.setLimit(com.google.protobuf.Int32Value.Builder builderForValue) Limits the number of entities to be returned.Required.setParentBytes(com.google.protobuf.ByteString value) Required.Required.setQueryBytes(com.google.protobuf.ByteString value) Required.Restricts returned entities with these types, e.g.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.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.GeneratedMessage.Builder<SearchRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.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
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
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
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
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
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
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
Required. The literal query string for search.
string query = 2 [(.google.api.field_behavior) = REQUIRED];- Returns:
- This builder for chaining.
-
setQueryBytes
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
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
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
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
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
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
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
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
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
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
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
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
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
Limits the number of entities to be returned.
.google.protobuf.Int32Value limit = 6; -
setLimit
Limits the number of entities to be returned.
.google.protobuf.Int32Value limit = 6; -
mergeLimit
Limits the number of entities to be returned.
.google.protobuf.Int32Value limit = 6; -
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
-