Class QueryDataObjectsRequest (0.1.0)

public final class QueryDataObjectsRequest extends GeneratedMessageV3 implements QueryDataObjectsRequestOrBuilder

Request message for DataObjectSearchService.QueryDataObjects.

Protobuf type google.cloud.vectorsearch.v1beta.QueryDataObjectsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_FIELDS_FIELD_NUMBER

public static final int OUTPUT_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QueryDataObjectsRequest getDefaultInstance()
Returns
Type Description
QueryDataObjectsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(QueryDataObjectsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public QueryDataObjectsRequest getDefaultInstanceForType()
Returns
Type Description
QueryDataObjectsRequest

getFilter()

public Struct getFilter()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The filter.

getFilterOrBuilder()

public StructOrBuilder getFilterOrBuilder()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getOutputFields()

public OutputFields getOutputFields()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputFields

The outputFields.

getOutputFieldsOrBuilder()

public OutputFieldsOrBuilder getOutputFieldsOrBuilder()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputFieldsOrBuilder

getPageSize()

public int getPageSize()

Optional. The standard list page size.

int32 page_size = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The standard list page token. Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call.

string page_token = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The standard list page token. Typically obtained via QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects call.

string page_token = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the Collection for which to query. Format: projects/{project}/locations/{location}/collections/{collection}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the Collection for which to query. Format: projects/{project}/locations/{location}/collections/{collection}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasFilter()

public boolean hasFilter()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the filter field is set.

hasOutputFields()

public boolean hasOutputFields()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the outputFields 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 QueryDataObjectsRequest.Builder newBuilderForType()
Returns
Type Description
QueryDataObjectsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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