Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class OrderByAnnotation.
Expression that allows ranking results based on annotation's property.
Generated from protobuf message google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation
Namespace
Google \ Cloud \ AIPlatform \ V1 \ SearchDataItemsRequest
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ saved_query
string
Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.
↳ order_by
string
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.
getSavedQuery
Required. Saved query of the Annotation. Only Annotations belong to this
saved query will be considered for ordering.
Returns
Type
Description
string
setSavedQuery
Required. Saved query of the Annotation. Only Annotations belong to this
saved query will be considered for ordering.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
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.
Returns
Type
Description
string
setOrderBy
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class OrderByAnnotation (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.SearchDataItemsRequest.OrderByAnnotation)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.SearchDataItemsRequest.OrderByAnnotation) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class OrderByAnnotation.\n\nExpression that allows ranking results based on annotation's property.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1 \\\\ SearchDataItemsRequest\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSavedQuery\n\nRequired. Saved query of the Annotation. Only Annotations belong to this\nsaved query will be considered for ordering.\n\n### setSavedQuery\n\nRequired. Saved query of the Annotation. Only Annotations belong to this\nsaved query will be considered for ordering.\n\n### getOrderBy\n\nA comma-separated list of annotation fields to order by, sorted in\nascending order. Use \"desc\" after a field name for descending. Must also\nspecify saved_query.\n\n### setOrderBy\n\nA comma-separated list of annotation fields to order by, sorted in\nascending order. Use \"desc\" after a field name for descending. Must also\nspecify saved_query."]]
