list method
Lists jobs for a given pipeline.
Throws a "FORBIDDEN" error if the caller doesn't have permission to access it.
Request parameters:
parent
- Required. The pipeline name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID
.
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/pipelines/\[^/\]+$
.
pageSize
- The maximum number of entities to return. The service may
return fewer than this value, even if there are additional pages. If
unspecified, the max limit will be determined by the backend
implementation.
pageToken
- A page token, received from a previous ListJobs
call.
Provide this to retrieve the subsequent page. When paginating, all other
parameters provided to ListJobs
must match the call that provided the
page token.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudDatapipelinesV1ListJobsResponse.
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<GoogleCloudDatapipelinesV1ListJobsResponse> list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/jobs';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudDatapipelinesV1ListJobsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}