Class SearchDataItemsRequest.OrderByAnnotation (3.24.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.v1.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
TypeDescription
int

SAVED_QUERY_FIELD_NUMBER

public static final int SAVED_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchDataItemsRequest.OrderByAnnotation getDefaultInstance()
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation

getDescriptor()

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

newBuilder()

public static SearchDataItemsRequest.OrderByAnnotation.Builder newBuilder()
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder

newBuilder(SearchDataItemsRequest.OrderByAnnotation prototype)

public static SearchDataItemsRequest.OrderByAnnotation.Builder newBuilder(SearchDataItemsRequest.OrderByAnnotation prototype)
Parameter
NameDescription
prototypeSearchDataItemsRequest.OrderByAnnotation
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder

parseDelimitedFrom(InputStream input)

public static SearchDataItemsRequest.OrderByAnnotation parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDataItemsRequest.OrderByAnnotation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchDataItemsRequest.OrderByAnnotation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchDataItemsRequest.OrderByAnnotation getDefaultInstanceForType()
Returns
TypeDescription
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
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.

getParserForType()

public Parser<SearchDataItemsRequest.OrderByAnnotation> getParserForType()
Returns
TypeDescription
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
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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchDataItemsRequest.OrderByAnnotation.Builder newBuilderForType()
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchDataItemsRequest.OrderByAnnotation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchDataItemsRequest.OrderByAnnotation.Builder toBuilder()
Returns
TypeDescription
SearchDataItemsRequest.OrderByAnnotation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException