Class OutputFields.Builder (0.1.0)

public static final class OutputFields.Builder extends GeneratedMessageV3.Builder<OutputFields.Builder> implements OutputFieldsOrBuilder

Defines a output fields struct for data in DataObject.

Protobuf type google.cloud.vectorsearch.v1beta.OutputFields

Static Methods

getDescriptor()

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

Methods

addAllDataFields(Iterable<String> values)

public OutputFields.Builder addAllDataFields(Iterable<String> values)

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
values Iterable<String>

The dataFields to add.

Returns
Type Description
OutputFields.Builder

This builder for chaining.

addAllMetadataFields(Iterable<String> values)

public OutputFields.Builder addAllMetadataFields(Iterable<String> values)

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
values Iterable<String>

The metadataFields to add.

Returns
Type Description
OutputFields.Builder

This builder for chaining.

addAllVectorFields(Iterable<String> values)

public OutputFields.Builder addAllVectorFields(Iterable<String> values)

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
values Iterable<String>

The vectorFields to add.

Returns
Type Description
OutputFields.Builder

This builder for chaining.

addDataFields(String value)

public OutputFields.Builder addDataFields(String value)

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
value String

The dataFields to add.

Returns
Type Description
OutputFields.Builder

This builder for chaining.

addDataFieldsBytes(ByteString value)

public OutputFields.Builder addDataFieldsBytes(ByteString value)

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
value ByteString

The bytes of the dataFields to add.

Returns
Type Description
OutputFields.Builder

This builder for chaining.

addMetadataFields(String value)

public OutputFields.Builder addMetadataFields(String value)

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
value String

The metadataFields to add.

Returns
Type Description
OutputFields.Builder

This builder for chaining.

addMetadataFieldsBytes(ByteString value)

public OutputFields.Builder addMetadataFieldsBytes(ByteString value)

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
value ByteString

The bytes of the metadataFields to add.

Returns
Type Description
OutputFields.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public OutputFields.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
OutputFields.Builder
Overrides

addVectorFields(String value)

public OutputFields.Builder addVectorFields(String value)

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
value String

The vectorFields to add.

Returns
Type Description
OutputFields.Builder

This builder for chaining.

addVectorFieldsBytes(ByteString value)

public OutputFields.Builder addVectorFieldsBytes(ByteString value)

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
value ByteString

The bytes of the vectorFields to add.

Returns
Type Description
OutputFields.Builder

This builder for chaining.

build()

public OutputFields build()
Returns
Type Description
OutputFields

buildPartial()

public OutputFields buildPartial()
Returns
Type Description
OutputFields

clear()

public OutputFields.Builder clear()
Returns
Type Description
OutputFields.Builder
Overrides

clearDataFields()

public OutputFields.Builder clearDataFields()

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
OutputFields.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public OutputFields.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
OutputFields.Builder
Overrides

clearMetadataFields()

public OutputFields.Builder clearMetadataFields()

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
OutputFields.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public OutputFields.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
OutputFields.Builder
Overrides

clearVectorFields()

public OutputFields.Builder clearVectorFields()

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
OutputFields.Builder

This builder for chaining.

clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(OutputFields other)

public OutputFields.Builder mergeFrom(OutputFields other)
Parameter
Name Description
other OutputFields
Returns
Type Description
OutputFields.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public OutputFields.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OutputFields.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public OutputFields.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
OutputFields.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OutputFields.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
OutputFields.Builder
Overrides

setDataFields(int index, String value)

public OutputFields.Builder setDataFields(int index, String value)

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

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

Parameters
Name Description
index int

The index to set the value at.

value String

The dataFields to set.

Returns
Type Description
OutputFields.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public OutputFields.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
OutputFields.Builder
Overrides

setMetadataFields(int index, String value)

public OutputFields.Builder setMetadataFields(int index, String value)

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

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

Parameters
Name Description
index int

The index to set the value at.

value String

The metadataFields to set.

Returns
Type Description
OutputFields.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public OutputFields.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
OutputFields.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final OutputFields.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
OutputFields.Builder
Overrides

setVectorFields(int index, String value)

public OutputFields.Builder setVectorFields(int index, String value)

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

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

Parameters
Name Description
index int

The index to set the value at.

value String

The vectorFields to set.

Returns
Type Description
OutputFields.Builder

This builder for chaining.