Class SearchPublicKgRequest (0.13.0)

public final class SearchPublicKgRequest extends GeneratedMessageV3 implements SearchPublicKgRequestOrBuilder

Request message for EnterpriseKnowledgeGraphService.Search.

Protobuf type google.cloud.enterpriseknowledgegraph.v1.SearchPublicKgRequest

Static Fields

LANGUAGES_FIELD_NUMBER

public static final int LANGUAGES_FIELD_NUMBER
Field Value
TypeDescription
int

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

TYPES_FIELD_NUMBER

public static final int TYPES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchPublicKgRequest getDefaultInstance()
Returns
TypeDescription
SearchPublicKgRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchPublicKgRequest.Builder newBuilder()
Returns
TypeDescription
SearchPublicKgRequest.Builder

newBuilder(SearchPublicKgRequest prototype)

public static SearchPublicKgRequest.Builder newBuilder(SearchPublicKgRequest prototype)
Parameter
NameDescription
prototypeSearchPublicKgRequest
Returns
TypeDescription
SearchPublicKgRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchPublicKgRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchPublicKgRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchPublicKgRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchPublicKgRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchPublicKgRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchPublicKgRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchPublicKgRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchPublicKgRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchPublicKgRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchPublicKgRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchPublicKgRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchPublicKgRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchPublicKgRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchPublicKgRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchPublicKgRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchPublicKgRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchPublicKgRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchPublicKgRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchPublicKgRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchPublicKgRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchPublicKgRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchPublicKgRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchPublicKgRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchPublicKgRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SearchPublicKgRequest> parser()
Returns
TypeDescription
Parser<SearchPublicKgRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchPublicKgRequest getDefaultInstanceForType()
Returns
TypeDescription
SearchPublicKgRequest

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.

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.

getParserForType()

public Parser<SearchPublicKgRequest> getParserForType()
Returns
TypeDescription
Parser<SearchPublicKgRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchPublicKgRequest.Builder newBuilderForType()
Returns
TypeDescription
SearchPublicKgRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchPublicKgRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchPublicKgRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchPublicKgRequest.Builder toBuilder()
Returns
TypeDescription
SearchPublicKgRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException