prefect_github.repository_owner
¶
This is a module containing: GitHub query_repository_owner* tasks
query_repository_owner
async
¶
The query root of GitHub's GraphQL interface.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
login |
str
|
The username to lookup the owner by. |
required |
github_credentials |
GitHubCredentials
|
Credentials to use for authentication with GitHub. |
required |
return_fields |
Iterable[str]
|
Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json. |
None
|
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
A dict of the returned fields. |
Source code in prefect_github/repository_owner.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
|
query_repository_owner_repositories
async
¶
A list of repositories that the user owns.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
login |
str
|
The username to lookup the owner by. |
required |
github_credentials |
GitHubCredentials
|
Credentials to use for authentication with GitHub. |
required |
privacy |
RepositoryPrivacy
|
If non-null, filters repositories according to privacy. |
None
|
order_by |
RepositoryOrder
|
Ordering options for repositories returned from the connection. |
None
|
affiliations |
Iterable[RepositoryAffiliation]
|
Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns. |
None
|
owner_affiliations |
Iterable[RepositoryAffiliation]
|
Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns. |
('OWNER', 'COLLABORATOR')
|
is_locked |
bool
|
If non-null, filters repositories according to whether they have been locked. |
None
|
after |
str
|
Returns the elements in the list that come after the specified cursor. |
None
|
before |
str
|
Returns the elements in the list that come before the specified cursor. |
None
|
first |
int
|
Returns the first n elements from the list. |
None
|
last |
int
|
Returns the last n elements from the list. |
None
|
is_fork |
bool
|
If non-null, filters repositories according to whether they are forks of another repository. |
None
|
return_fields |
Iterable[str]
|
Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json. |
None
|
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
A dict of the returned fields. |
Source code in prefect_github/repository_owner.py
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
|
query_repository_owner_repository
async
¶
Find Repository.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
login |
str
|
The username to lookup the owner by. |
required |
name |
str
|
Name of Repository to find. |
required |
github_credentials |
GitHubCredentials
|
Credentials to use for authentication with GitHub. |
required |
follow_renames |
bool
|
Follow repository renames. If disabled, a repository referenced by its old name will return an error. |
True
|
return_fields |
Iterable[str]
|
Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json. |
None
|
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
A dict of the returned fields. |
Source code in prefect_github/repository_owner.py
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
|