Class SearchDataItemsRequest.OrderByAnnotation.Builder (3.29.0)

public static final class SearchDataItemsRequest.OrderByAnnotation.Builder extends GeneratedMessageV3.Builder<SearchDataItemsRequest.OrderByAnnotation.Builder> implements SearchDataItemsRequest.OrderByAnnotationOrBuilder

Expression that allows ranking results based on annotation's property.

Protobuf type google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchDataItemsRequest.OrderByAnnotation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides

build()

public SearchDataItemsRequest.OrderByAnnotation build()
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation

buildPartial()

public SearchDataItemsRequest.OrderByAnnotation buildPartial()
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation

clear()

public SearchDataItemsRequest.OrderByAnnotation.Builder clear()
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchDataItemsRequest.OrderByAnnotation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchDataItemsRequest.OrderByAnnotation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides

clearOrderBy()

public SearchDataItemsRequest.OrderByAnnotation.Builder clearOrderBy()

A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query.

string order_by = 2;

Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder

This builder for chaining.

clearSavedQuery()

public SearchDataItemsRequest.OrderByAnnotation.Builder clearSavedQuery()

Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

string saved_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder

This builder for chaining.

clone()

public SearchDataItemsRequest.OrderByAnnotation.Builder clone()
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides

getDefaultInstanceForType()

public SearchDataItemsRequest.OrderByAnnotation getDefaultInstanceForType()
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getOrderBy()

public String getOrderBy()

A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query.

string order_by = 2;

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query.

string order_by = 2;

Returns
TypeDescription
ByteString

The bytes for orderBy.

getSavedQuery()

public String getSavedQuery()

Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

string saved_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The savedQuery.

getSavedQueryBytes()

public ByteString getSavedQueryBytes()

Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

string saved_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for savedQuery.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchDataItemsRequest.OrderByAnnotation other)

public SearchDataItemsRequest.OrderByAnnotation.Builder mergeFrom(SearchDataItemsRequest.OrderByAnnotation other)
Parameter
NameDescription
otherSearchDataItemsRequest.OrderByAnnotation
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchDataItemsRequest.OrderByAnnotation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchDataItemsRequest.OrderByAnnotation.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchDataItemsRequest.OrderByAnnotation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchDataItemsRequest.OrderByAnnotation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides

setOrderBy(String value)

public SearchDataItemsRequest.OrderByAnnotation.Builder setOrderBy(String value)

A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query.

string order_by = 2;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public SearchDataItemsRequest.OrderByAnnotation.Builder setOrderByBytes(ByteString value)

A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query.

string order_by = 2;

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder

This builder for chaining.

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

public SearchDataItemsRequest.OrderByAnnotation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides

setSavedQuery(String value)

public SearchDataItemsRequest.OrderByAnnotation.Builder setSavedQuery(String value)

Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

string saved_query = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The savedQuery to set.

Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder

This builder for chaining.

setSavedQueryBytes(ByteString value)

public SearchDataItemsRequest.OrderByAnnotation.Builder setSavedQueryBytes(ByteString value)

Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

string saved_query = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for savedQuery to set.

Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchDataItemsRequest.OrderByAnnotation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides