Class SearchRequest.Builder (0.11.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The languages to add.

Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The types to add.

Returns
TypeDescription
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
NameDescription
valueString

The languages to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the languages to add.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.Builder
Overrides

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
NameDescription
valueString

The types to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the types to add.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

build()

public SearchRequest build()
Returns
TypeDescription
SearchRequest

buildPartial()

public SearchRequest buildPartial()
Returns
TypeDescription
SearchRequest

clear()

public SearchRequest.Builder clear()
Returns
TypeDescription
SearchRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
SearchRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
SearchRequest.Builder

This builder for chaining.

clone()

public SearchRequest.Builder clone()
Returns
TypeDescription
SearchRequest.Builder
Overrides

getDefaultInstanceForType()

public SearchRequest getDefaultInstanceForType()
Returns
TypeDescription
SearchRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the languages.

getLimit()

public Int32Value getLimit()

Limits the number of entities to be returned.

.google.protobuf.Int32Value limit = 6;

Returns
TypeDescription
Int32Value

The limit.

getLimitBuilder()

public Int32Value.Builder getLimitBuilder()

Limits the number of entities to be returned.

.google.protobuf.Int32Value limit = 6;

Returns
TypeDescription
Builder

getLimitOrBuilder()

public Int32ValueOrBuilder getLimitOrBuilder()

Limits the number of entities to be returned.

.google.protobuf.Int32Value limit = 6;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

Required. The literal query string for search.

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

Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the types.

hasLimit()

public boolean hasLimit()

Limits the number of entities to be returned.

.google.protobuf.Int32Value limit = 6;

Returns
TypeDescription
boolean

Whether the limit field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchRequest other)

public SearchRequest.Builder mergeFrom(SearchRequest other)
Parameter
NameDescription
otherSearchRequest
Returns
TypeDescription
SearchRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchRequest.Builder
Overrides

mergeLimit(Int32Value value)

public SearchRequest.Builder mergeLimit(Int32Value value)

Limits the number of entities to be returned.

.google.protobuf.Int32Value limit = 6;

Parameter
NameDescription
valueInt32Value
Returns
TypeDescription
SearchRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.Builder
Overrides

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
NameDescription
indexint

The index to set the value at.

valueString

The languages to set.

Returns
TypeDescription
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
NameDescription
valueInt32Value
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
valueString

The query to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for query to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchRequest.Builder
Overrides

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
NameDescription
indexint

The index to set the value at.

valueString

The types to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.Builder
Overrides