Class OutputFields (0.1.0)

public final class OutputFields extends GeneratedMessageV3 implements OutputFieldsOrBuilder

Defines a output fields struct for data in DataObject.

Protobuf type google.cloud.vectorsearch.v1beta.OutputFields

Static Fields

DATA_FIELDS_FIELD_NUMBER

public static final int DATA_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELDS_FIELD_NUMBER

public static final int METADATA_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

VECTOR_FIELDS_FIELD_NUMBER

public static final int VECTOR_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OutputFields getDefaultInstance()
Returns
Type Description
OutputFields

getDescriptor()

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

newBuilder()

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

newBuilder(OutputFields prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDataFields(int index)

public String getDataFields(int index)

Optional. The fields from the data fields to include in the output.

repeated string data_fields = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The dataFields at the given index.

getDataFieldsBytes(int index)

public ByteString getDataFieldsBytes(int index)

Optional. The fields from the data fields to include in the output.

repeated string data_fields = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the dataFields at the given index.

getDataFieldsCount()

public int getDataFieldsCount()

Optional. The fields from the data fields to include in the output.

repeated string data_fields = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of dataFields.

getDataFieldsList()

public ProtocolStringList getDataFieldsList()

Optional. The fields from the data fields to include in the output.

repeated string data_fields = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the dataFields.

getDefaultInstanceForType()

public OutputFields getDefaultInstanceForType()
Returns
Type Description
OutputFields

getMetadataFields(int index)

public String getMetadataFields(int index)

Optional. The fields from the DataObject metadata to include in the output.

repeated string metadata_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The metadataFields at the given index.

getMetadataFieldsBytes(int index)

public ByteString getMetadataFieldsBytes(int index)

Optional. The fields from the DataObject metadata to include in the output.

repeated string metadata_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the metadataFields at the given index.

getMetadataFieldsCount()

public int getMetadataFieldsCount()

Optional. The fields from the DataObject metadata to include in the output.

repeated string metadata_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of metadataFields.

getMetadataFieldsList()

public ProtocolStringList getMetadataFieldsList()

Optional. The fields from the DataObject metadata to include in the output.

repeated string metadata_fields = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the metadataFields.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getVectorFields(int index)

public String getVectorFields(int index)

Optional. The fields from the vector fields to include in the output.

repeated string vector_fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The vectorFields at the given index.

getVectorFieldsBytes(int index)

public ByteString getVectorFieldsBytes(int index)

Optional. The fields from the vector fields to include in the output.

repeated string vector_fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the vectorFields at the given index.

getVectorFieldsCount()

public int getVectorFieldsCount()

Optional. The fields from the vector fields to include in the output.

repeated string vector_fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of vectorFields.

getVectorFieldsList()

public ProtocolStringList getVectorFieldsList()

Optional. The fields from the vector fields to include in the output.

repeated string vector_fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the vectorFields.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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