Skip to main content

project_nested_environments

Gets or lists a project_nested_environments resource.

Overview​

Nameproject_nested_environments
TypeResource
Idgitlab.projects.project_nested_environments

Fields​

The following fields are returned by SELECT queries:

GraphQL response envelope

NameDatatypeDescription
namestringHuman-readable name of the environment.
sizeintegerNumber of environments nested in the folder.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectfull_path, hostname, search, typeEnvironments for this project with nested folders, can only be resolved for one project in any single request Generated from the GitLab GraphQL schema field Project.nestedEnvironments (connection of NestedEnvironment nodes).

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.

NameDatatypeDescription
full_pathstringFull path of the project, for example gitlab-org/gitlab
hoststringGitLab 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)
namestringName of the environment.
typestringSearch query for environment type.

SELECT examples​

Environments for this project with nested folders, can only be resolved for one project in any single request Generated from the GitLab GraphQL schema field Project.nestedEnvironments (connection of NestedEnvironment nodes).

SELECT
name,
size
FROM gitlab.projects.project_nested_environments
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND name = '{{ name }}'
AND search = '{{ search }}'
AND type = '{{ type }}'
;