get method
Gets an example by resource name, including both data and annotation.
Request parameters:
name
- Required. Name of example, format:
projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
{annotated_dataset_id}/examples/{example_id}
Value must have pattern
^projects/\[^/\]+/datasets/\[^/\]+/annotatedDatasets/\[^/\]+/examples/\[^/\]+$
.
filter
- Optional. An expression for filtering Examples. Filter by
annotation_spec.display_name is supported. Format
"annotation_spec.display_name = {display_name}"
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudDatalabelingV1beta1Example.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<GoogleCloudDatalabelingV1beta1Example> get(
core.String name, {
core.String? filter,
core.String? $fields,
}) async {
final _queryParams = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if ($fields != null) 'fields': [$fields],
};
final _url = 'v1beta1/' + core.Uri.encodeFull('$name');
final _response = await _requester.request(
_url,
'GET',
queryParams: _queryParams,
);
return GoogleCloudDatalabelingV1beta1Example.fromJson(
_response as core.Map<core.String, core.dynamic>);
}