Class SearchRequest (0.51.0)

public final class SearchRequest extends GeneratedMessageV3 implements SearchRequestOrBuilder

Request message for EnterpriseKnowledgeGraphService.Search.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.SearchRequest

Static Fields

LANGUAGES_FIELD_NUMBER

public static final int LANGUAGES_FIELD_NUMBER
Field Value
Type Description
int

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

TYPES_FIELD_NUMBER

public static final int TYPES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchRequest getDefaultInstance()
Returns
Type Description
SearchRequest

getDescriptor()

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

newBuilder()

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

newBuilder(SearchRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchRequest getDefaultInstanceForType()
Returns
Type Description
SearchRequest

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.

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.

getParserForType()

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 SearchRequest.Builder newBuilderForType()
Returns
Type Description
SearchRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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