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
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.
Generated from protobuf field string saved_query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setSavedQuery
Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.
Generated from protobuf field string saved_query = 1 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field string order_by = 2;
| 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.
Generated from protobuf field string order_by = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |