Class SearchDataItemsRequest.OrderByAnnotation.Builder (3.47.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
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SearchDataItemsRequest.OrderByAnnotation build()
Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation

buildPartial()

public SearchDataItemsRequest.OrderByAnnotation buildPartial()
Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation

clear()

public SearchDataItemsRequest.OrderByAnnotation.Builder clear()
Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchDataItemsRequest.OrderByAnnotation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
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
Type Description
SearchDataItemsRequest.OrderByAnnotation.Builder

This builder for chaining.

clone()

public SearchDataItemsRequest.OrderByAnnotation.Builder clone()
Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides

getDefaultInstanceForType()

public SearchDataItemsRequest.OrderByAnnotation getDefaultInstanceForType()
Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for savedQuery.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchDataItemsRequest.OrderByAnnotation other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

public SearchDataItemsRequest.OrderByAnnotation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value String

The orderBy to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
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
Name Description
value String

The savedQuery to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for savedQuery to set.

Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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