2022-12-21
▼ ▲ datapipelines.projects.locations.pipelines.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.
Parameter Order: parent
Path: v1/{+parent}/pipelines
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.
Type: string
Location: path
Required: Yes
pageSize
Type: integer
Format: int32
Description: 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 is yet to be determined by the backend implementation.
Location: query
pageToken
Type: string
Description: A page token, received from a previous `ListPipelines` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPipelines` must match the call that provided the page token.
Location: query
filter
Type: string
Description: An expression for filtering the results of the request. If unspecified, all pipelines will be returned. Multiple filters can be applied and must be comma separated. Fields eligible for filtering are: + `type`: The type of the pipeline (streaming or batch). Allowed values are `ALL`, `BATCH`, and `STREAMING`. + `status`: The activity status of the pipeline. Allowed values are `ALL`, `ACTIVE`, `ARCHIVED`, and `PAUSED`. For example, to limit results to active batch processing pipelines: type:BATCH,status:ACTIVE
Location: query
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/pipelines
▼ ▲ datapipelines.projects.locations.listPipelines
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
Parameter Order: parent
Parameters:
pageSize
Location: query
Description: 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 is yet to be determined by the backend implementation.
Type: integer
Format: int32
pageToken
Description: A page token, received from a previous `ListPipelines` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPipelines` must match the call that provided the page token.
Type: string
Location: query
parent
Type: string
Description: Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
filter
Type: string
Description: An expression for filtering the results of the request. If unspecified, all pipelines will be returned. Multiple filters can be applied and must be comma separated. Fields eligible for filtering are: + `type`: The type of the pipeline (streaming or batch). Allowed values are `ALL`, `BATCH`, and `STREAMING`. + `status`: The activity status of the pipeline. Allowed values are `ALL`, `ACTIVE`, `ARCHIVED`, and `PAUSED`. For example, to limit results to active batch processing pipelines: type:BATCH,status:ACTIVE
Location: query
Path: v1/{+parent}
HTTP Method: GET
Description: Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.