ci_pipeline_stage
Gets or lists a ci_pipeline_stage resource.
Overview​
| Name | ci_pipeline_stage |
| Type | Resource |
| Id | gitlab.ci.ci_pipeline_stage |
Fields​
The following fields are returned by SELECT queries:
- get
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
id | string | ID of the stage. |
name | string | Name of the stage. |
status | string | Status of the pipeline stage. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id, host | Stage belonging to a CI pipeline. Generated from the GitLab GraphQL schema field Query.ciPipelineStage (CiStage). |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
host | string | GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST) |
id | string | Global ID of the CI stage. |
SELECT examples​
- get
Stage belonging to a CI pipeline. Generated from the GitLab GraphQL schema field Query.ciPipelineStage (CiStage).
SELECT
id,
name,
status
FROM gitlab.ci.ci_pipeline_stage
WHERE id = '{{ id }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;