Class SearchDataItemsRequest.OrderByAnnotation (3.49.0)

public static final class SearchDataItemsRequest.OrderByAnnotation extends GeneratedMessageV3 implements SearchDataItemsRequest.OrderByAnnotationOrBuilder

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

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchDataItemsRequest.OrderByAnnotation

Static Fields

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

SAVED_QUERY_FIELD_NUMBER

public static final int SAVED_QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchDataItemsRequest.OrderByAnnotation getDefaultInstance()
Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation

getDescriptor()

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

newBuilder()

public static SearchDataItemsRequest.OrderByAnnotation.Builder newBuilder()
Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation.Builder

newBuilder(SearchDataItemsRequest.OrderByAnnotation prototype)

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

parseDelimitedFrom(InputStream input)

public static SearchDataItemsRequest.OrderByAnnotation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<SearchDataItemsRequest.OrderByAnnotation> parser()
Returns
Type Description
Parser<OrderByAnnotation>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

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.

getParserForType()

public Parser<SearchDataItemsRequest.OrderByAnnotation> getParserForType()
Returns
Type Description
Parser<OrderByAnnotation>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SearchDataItemsRequest.OrderByAnnotation.Builder toBuilder()
Returns
Type Description
SearchDataItemsRequest.OrderByAnnotation.Builder

writeTo(CodedOutputStream output)

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