project_data_transfer
Gets or lists a project_data_transfer resource.
Overview​
| Name | project_data_transfer |
| Type | Resource |
| Id | gitlab.projects.project_data_transfer |
Fields​
The following fields are returned by SELECT queries:
- get
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
total_egress | string | Total egress for that project in that period of time. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | full_path, host | from_, to_ | Data transfer data point for a specific period. This is mocked data under a development feature flag. Generated from the GitLab GraphQL schema field Project.dataTransfer (ProjectDataTransfer). |
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 |
|---|---|---|
full_path | string | Full path of the project, for example gitlab-org/gitlab |
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) |
from_ | string | Retain egress data for one year. Data for the current month will increase dynamically as egress occurs. |
to_ | string | End date for the data. |
SELECT examples​
- get
Data transfer data point for a specific period. This is mocked data under a development feature flag. Generated from the GitLab GraphQL schema field Project.dataTransfer (ProjectDataTransfer).
SELECT
total_egress
FROM gitlab.projects.project_data_transfer
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND from_ = '{{ from_ }}'
AND to_ = '{{ to_ }}'
;