Class SearchRequest.Builder (0.37.0)

public static final class SearchRequest.Builder extends GeneratedMessageV3.Builder<SearchRequest.Builder> implements SearchRequestOrBuilder

Request message for EnterpriseKnowledgeGraphService.Search.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.SearchRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchRequest.Builder

Implements

SearchRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllLanguages(Iterable<String> values)

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;

Parameter
Name	Description
`values`	`Iterable<String>` The languages to add.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

addAllTypes(Iterable<String> values)

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;

Parameter
Name	Description
`values`	`Iterable<String>` The types to add.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

addLanguages(String value)

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;

Parameter
Name	Description
`value`	`String` The languages to add.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

addLanguagesBytes(ByteString value)

public SearchRequest.Builder addLanguagesBytes(ByteString value)

The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.

repeated string languages = 3;

Parameter
Name	Description
`value`	`ByteString` The bytes of the languages to add.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addTypes(String value)

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;

Parameter
Name	Description
`value`	`String` The types to add.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

addTypesBytes(ByteString value)

public SearchRequest.Builder addTypesBytes(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;

Parameter
Name	Description
`value`	`ByteString` The bytes of the types to add.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

build()

public SearchRequest build()

Returns
Type	Description
`SearchRequest`

buildPartial()

public SearchRequest buildPartial()

Returns
Type	Description
`SearchRequest`

clear()

public SearchRequest.Builder clear()

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clearLimit()

public SearchRequest.Builder clearLimit()

Limits the number of entities to be returned.

.google.protobuf.Int32Value limit = 6;

Returns
Type	Description
`SearchRequest.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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
Type	Description
`SearchRequest.Builder`	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
Type	Description
`SearchRequest.Builder`	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
Type	Description
`SearchRequest.Builder`	This builder for chaining.

clone()

public SearchRequest.Builder clone()

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchRequest getDefaultInstanceForType()

Returns
Type	Description
`SearchRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getLanguages(int index)

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;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The languages at the given index.

getLanguagesBytes(int index)

public 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;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the languages at the given index.

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;

Returns
Type	Description
`int`	The count of languages.

getLanguagesList()

public ProtocolStringList getLanguagesList()

The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.

repeated string languages = 3;

Returns
Type	Description
`ProtocolStringList`	A list containing the languages.

getLimit()

public Int32Value getLimit()

Limits the number of entities to be returned.

.google.protobuf.Int32Value limit = 6;

Returns
Type	Description
`Int32Value`	The limit.

getLimitBuilder()

public Int32Value.Builder getLimitBuilder()

Limits the number of entities to be returned.

.google.protobuf.Int32Value limit = 6;

Returns
Type	Description
`Builder`

getLimitOrBuilder()

public Int32ValueOrBuilder getLimitOrBuilder()

Limits the number of entities to be returned.

.google.protobuf.Int32Value limit = 6;

Returns
Type	Description
`Int32ValueOrBuilder`

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) = { ... }

Returns
Type	Description
`String`	The parent.

getParentBytes()

public 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) = { ... }

Returns
Type	Description
`ByteString`	The bytes for parent.

getQuery()

public String getQuery()

Required. The literal query string for search.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The query.

getQueryBytes()

public ByteString getQueryBytes()

Required. The literal query string for search.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for query.

getTypes(int index)

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;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The types at the given index.

getTypesBytes(int index)

public 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;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the types at the given index.

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;

Returns
Type	Description
`int`	The count of types.

getTypesList()

public 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;

Returns
Type	Description
`ProtocolStringList`	A list containing the types.

hasLimit()

public boolean hasLimit()

Limits the number of entities to be returned.

.google.protobuf.Int32Value limit = 6;

Returns
Type	Description
`boolean`	Whether the limit field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SearchRequest other)

public SearchRequest.Builder mergeFrom(SearchRequest other)

Parameter
Name	Description
`other`	`SearchRequest`

Returns
Type	Description
`SearchRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public SearchRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeLimit(Int32Value value)

public SearchRequest.Builder mergeLimit(Int32Value value)

Limits the number of entities to be returned.

.google.protobuf.Int32Value limit = 6;

Parameter
Name	Description
`value`	`Int32Value`

Returns
Type	Description
`SearchRequest.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setLanguages(int index, String value)

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
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The languages to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setLimit(Int32Value value)

public SearchRequest.Builder setLimit(Int32Value value)

Limits the number of entities to be returned.

.google.protobuf.Int32Value limit = 6;

Parameter
Name	Description
`value`	`Int32Value`

Returns
Type	Description
`SearchRequest.Builder`

setLimit(Int32Value.Builder builderForValue)

public SearchRequest.Builder setLimit(Int32Value.Builder builderForValue)

Limits the number of entities to be returned.

.google.protobuf.Int32Value limit = 6;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`SearchRequest.Builder`

setParent(String value)

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) = { ... }

Parameter
Name	Description
`value`	`String` The parent to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setParentBytes(ByteString value)

public SearchRequest.Builder setParentBytes(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) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for parent to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setQuery(String value)

public SearchRequest.Builder setQuery(String value)

Required. The literal query string for search.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`String` The query to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setQueryBytes(ByteString value)

public SearchRequest.Builder setQueryBytes(ByteString value)

Required. The literal query string for search.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`ByteString` The bytes for query to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTypes(int index, String value)

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
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The types to set.

Returns
Type	Description
`SearchRequest.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)