Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListAnnotationsRequest.
Request message for DatasetService.ListAnnotations.
Generated from protobuf message google.cloud.aiplatform.v1.ListAnnotationsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the DataItem to list Annotations from. Format: |
↳ filter |
string
The standard list filter. |
↳ page_size |
int
The standard list page size. |
↳ page_token |
string
The standard list page token. |
↳ read_mask |
Google\Protobuf\FieldMask
Mask specifying which fields to read. |
↳ order_by |
string
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. |
getParent
Required. The resource name of the DataItem to list Annotations from.
Format:
projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The resource name of the DataItem to list Annotations from.
Format:
projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
The standard list filter.
Generated from protobuf field string filter = 2;
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
The standard list filter.
Generated from protobuf field string filter = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
The standard list page size.
Generated from protobuf field int32 page_size = 3;
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
The standard list page size.
Generated from protobuf field int32 page_size = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
The standard list page token.
Generated from protobuf field string page_token = 4;
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
The standard list page token.
Generated from protobuf field string page_token = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReadMask
Mask specifying which fields to read.
Generated from protobuf field .google.protobuf.FieldMask read_mask = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null |
|
hasReadMask
clearReadMask
setReadMask
Mask specifying which fields to read.
Generated from protobuf field .google.protobuf.FieldMask read_mask = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
A comma-separated list of fields to order by, sorted in ascending order.
Use "desc" after a field name for descending.
Generated from protobuf field string order_by = 6;
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
A comma-separated list of fields to order by, sorted in ascending order.
Use "desc" after a field name for descending.
Generated from protobuf field string order_by = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|