Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class ListExamplesRequest.
Request message for ListExamples.
Generated from protobuf message google.cloud.datalabeling.v1beta1.ListExamplesRequest
Methods
build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. Example resource parent. Please see {@see \Google\Cloud\DataLabeling\V1beta1\DataLabelingServiceClient::annotatedDatasetName()} for help formatting this field. |
filter |
string
Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}" |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DataLabeling\V1beta1\ListExamplesRequest | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Example resource parent. |
↳ filter |
string
Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}" |
↳ page_size |
int
Optional. Requested page size. Server may return fewer results than requested. Default value is 100. |
↳ page_token |
string
Optional. A token identifying a page of results for the server to return. Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty. |
getParent
Required. Example resource parent.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. Example resource parent.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
Optional. A token identifying a page of results for the server to return.
Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
Optional. A token identifying a page of results for the server to return.
Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |