Skip to main content

group_pipeline_execution_schedule_policies

Gets or lists a group_pipeline_execution_schedule_policies resource.

Overview​

Namegroup_pipeline_execution_schedule_policies
TypeResource
Idgitlab.ci.group_pipeline_execution_schedule_policies

Fields​

The following fields are returned by SELECT queries:

GraphQL response envelope

NameDatatypeDescription
namestringName of the policy.
descriptionstringDescription of the policy.
edit_pathstringURL of policy edit page.
enabledbooleanIndicates whether the policy is enabled.
policy_blob_file_pathstringPath to the policy file in the project.
updated_atstringTimestamp of when the policy YAML was last updated.
warningsarray
yamlstringYAML definition of the policy.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectfull_path, hostdeduplicate_policies, include_unscoped, relationshipPipeline Execution Schedule Policies of the namespace. Generated from the GitLab GraphQL schema field Group.pipelineExecutionSchedulePolicies (connection of PipelineExecutionSchedulePolicy 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 group, for example gitlab-org
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)
deduplicate_policiesbooleanRemove duplicate policies when the same policy is applied via multiple routes.
include_unscopedbooleanFilter policies that are scoped to the project.
relationshipstringFilter policies by the given policy relationship. Default is DIRECT.

SELECT examples​

Pipeline Execution Schedule Policies of the namespace. Generated from the GitLab GraphQL schema field Group.pipelineExecutionSchedulePolicies (connection of PipelineExecutionSchedulePolicy nodes).

SELECT
name,
description,
edit_path,
enabled,
policy_blob_file_path,
updated_at,
warnings,
yaml
FROM gitlab.ci.group_pipeline_execution_schedule_policies
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND deduplicate_policies = '{{ deduplicate_policies }}'
AND include_unscoped = '{{ include_unscoped }}'
AND relationship = '{{ relationship }}'
;