arvados.api_resources
Arvados API client reference documentation
This module provides reference documentation for the interface of the
Arvados API client, including method signatures and type information for
returned objects. However, the functions in arvados.api will return
different classes at runtime that are generated dynamically from the Arvados
API discovery document. The classes in this module do not have any
implementation, and you should not instantiate them in your code.
If you’re just starting out, ArvadosAPIClient documents the methods
available from the client object. From there, you can follow the trail into
resource methods, request objects, and finally the data dictionaries returned
by the API server.
1"""Arvados API client reference documentation 2 3This module provides reference documentation for the interface of the 4Arvados API client, including method signatures and type information for 5returned objects. However, the functions in `arvados.api` will return 6different classes at runtime that are generated dynamically from the Arvados 7API discovery document. The classes in this module do not have any 8implementation, and you should not instantiate them in your code. 9 10If you're just starting out, `ArvadosAPIClient` documents the methods 11available from the client object. From there, you can follow the trail into 12resource methods, request objects, and finally the data dictionaries returned 13by the API server. 14""" 15 16import googleapiclient.discovery 17import googleapiclient.http 18import httplib2 19import sys 20from typing import Any, Dict, Generic, List, Literal, Optional, TypedDict, TypeVar 21 22# ST represents an API response type 23ST = TypeVar('ST', bound=TypedDict) 24 25 26class ArvadosAPIRequest(googleapiclient.http.HttpRequest, Generic[ST]): 27 """Generic API request object 28 29 When you call an API method in the Arvados Python SDK, it returns a 30 request object. You usually call `execute()` on this object to submit the 31 request to your Arvados API server and retrieve the response. `execute()` 32 will return the type of object annotated in the subscript of 33 `ArvadosAPIRequest`. 34 """ 35 36 def execute(self, http: Optional[httplib2.Http]=None, num_retries: int=0) -> ST: 37 """Execute this request and return the response 38 39 Arguments: 40 41 * http: httplib2.Http | None --- The HTTP client object to use to 42 execute the request. If not specified, uses the HTTP client object 43 created with the API client object. 44 45 * num_retries: int --- The maximum number of times to retry this 46 request if the server returns a retryable failure. The API client 47 object also has a maximum number of retries specified when it is 48 instantiated (see `arvados.api.api_client`). This request is run 49 with the larger of that number and this argument. Default 0. 50 """ 51 52 53class ApiClientAuthorization(TypedDict, total=False): 54 """Arvados API client authorization token 55 56 This resource represents an API token a user may use to authenticate an 57 Arvados API request. 58 59 This is the dictionary object that represents a single ApiClientAuthorization in Arvados 60 and is returned by most `ApiClientAuthorizations` methods. 61 The keys of the dictionary are documented below, along with their types. 62 Not every key may appear in every dictionary returned by an API call. 63 When a method doesn't return all the data, you can use its `select` parameter 64 to list the specific keys you need. Refer to the API documentation for details. 65 """ 66 etag: 'str' 67 """Object cache version.""" 68 api_token: 'str' 69 """The secret token that can be used to authorize Arvados API requests.""" 70 created_by_ip_address: 'str' 71 """The IP address of the client that created this token.""" 72 last_used_by_ip_address: 'str' 73 """The IP address of the client that last used this token.""" 74 last_used_at: 'str' 75 """The last time this token was used to authorize a request. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 76 expires_at: 'str' 77 """The time after which this token is no longer valid for authorization. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 78 created_at: 'str' 79 """The time this API client authorization was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 80 scopes: 'List' 81 """An array of strings identifying HTTP methods and API paths this token is 82 authorized to use. Refer to the [scopes reference][] for details. 83 84 [scopes reference]: https://doc.arvados.org/api/tokens.html#scopes 85 """ 86 uuid: 'str' 87 """This API client authorization's Arvados UUID, like `zzzzz-gj3su-12345abcde67890`.""" 88 89 90class ApiClientAuthorizationList(TypedDict, total=False): 91 """A list of ApiClientAuthorization objects. 92 93 This is the dictionary object returned when you call `ApiClientAuthorizations.list`. 94 If you just want to iterate all objects that match your search criteria, 95 consider using `arvados.util.keyset_list_all`. 96 If you work with this raw object, the keys of the dictionary are documented 97 below, along with their types. The `items` key maps to a list of matching 98 `ApiClientAuthorization` objects. 99 """ 100 kind: 'str' = 'arvados#apiClientAuthorizationList' 101 """Object type. Always arvados#apiClientAuthorizationList.""" 102 etag: 'str' 103 """List cache version.""" 104 items: 'List[ApiClientAuthorization]' 105 """An array of matching ApiClientAuthorization objects.""" 106 107 108class ApiClientAuthorizations: 109 """Methods to query and manipulate Arvados api client authorizations""" 110 111 def create(self, *, body: "Dict[Literal['api_client_authorization'], ApiClientAuthorization]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 112 """Create a new ApiClientAuthorization. 113 114 Required parameters: 115 116 * body: Dict[Literal['api_client_authorization'], ApiClientAuthorization] --- A dictionary with a single item `'api_client_authorization'`. 117 Its value is a `ApiClientAuthorization` dictionary defining the attributes to set. 118 119 Optional parameters: 120 121 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 122 123 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 124 125 * select: Optional[List] --- An array of names of attributes to return in the response. 126 """ 127 128 def create_system_auth(self, *, scopes: 'List' = ['all']) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 129 """Create a token for the system ("root") user. 130 131 Optional parameters: 132 133 * scopes: List --- An array of strings defining the scope of resources this token will be allowed to access. Refer to the [scopes reference][] for details. Default `['all']`. 134 135 [scopes reference]: https://doc.arvados.org/api/tokens.html#scopes 136 """ 137 138 def current(self) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 139 """Return all metadata for the token used to authorize this request.""" 140 141 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ApiClientAuthorization]': 142 """Delete an existing ApiClientAuthorization. 143 144 Required parameters: 145 146 * uuid: str --- The UUID of the ApiClientAuthorization to delete. 147 """ 148 149 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 150 """Get a ApiClientAuthorization record by UUID. 151 152 Required parameters: 153 154 * uuid: str --- The UUID of the ApiClientAuthorization to return. 155 156 Optional parameters: 157 158 * select: Optional[List] --- An array of names of attributes to return in the response. 159 """ 160 161 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[ApiClientAuthorizationList]': 162 """Retrieve a ApiClientAuthorizationList. 163 164 This method returns a single page of `ApiClientAuthorization` objects that match your search 165 criteria. If you just want to iterate all objects that match your search 166 criteria, consider using `arvados.util.keyset_list_all`. 167 168 Optional parameters: 169 170 * bypass_federation: bool --- If true, do not return results from other clusters in the 171 federation, only the cluster that received the request. 172 You must be an administrator to use this flag. Default `False`. 173 174 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 175 176 * count: str --- A string to determine result counting behavior. Supported values are: 177 178 * `"exact"`: The response will include an `items_available` field that 179 counts the number of objects that matched this search criteria, 180 including ones not included in `items`. 181 182 * `"none"`: The response will not include an `items_avaliable` 183 field. This improves performance by returning a result as soon as enough 184 `items` have been loaded for this result. 185 186 Default `'exact'`. 187 188 * distinct: bool --- If this is true, and multiple objects have the same values 189 for the attributes that you specify in the `select` parameter, then each unique 190 set of values will only be returned once in the result set. Default `False`. 191 192 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 193 Refer to the [filters reference][] for more information about how to write filters. 194 195 [filters reference]: https://doc.arvados.org/api/methods.html#filters 196 197 * limit: int --- The maximum number of objects to return in the result. 198 Note that the API may return fewer results than this if your request hits other 199 limits set by the administrator. Default `100`. 200 201 * offset: int --- Return matching objects starting from this index. 202 Note that result indexes may change if objects are modified in between a series 203 of list calls. Default `0`. 204 205 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 206 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 207 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 208 209 * select: Optional[List] --- An array of names of attributes to return from each matching object. 210 211 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 212 The keys of this object are attribute names. 213 Each value is either a single matching value or an array of matching values for that attribute. 214 The `filters` parameter is more flexible and preferred. 215 """ 216 217 def update(self, *, body: "Dict[Literal['api_client_authorization'], ApiClientAuthorization]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 218 """Update attributes of an existing ApiClientAuthorization. 219 220 Required parameters: 221 222 * body: Dict[Literal['api_client_authorization'], ApiClientAuthorization] --- A dictionary with a single item `'api_client_authorization'`. 223 Its value is a `ApiClientAuthorization` dictionary defining the attributes to set. 224 225 * uuid: str --- The UUID of the ApiClientAuthorization to update. 226 227 Optional parameters: 228 229 * select: Optional[List] --- An array of names of attributes to return in the response. 230 """ 231 232 233class AuthorizedKey(TypedDict, total=False): 234 """Arvados authorized public key 235 236 This resource represents a public key a user may use to authenticate themselves 237 to services on the cluster. Its primary use today is to store SSH keys for 238 virtual machines ("shell nodes"). It may be extended to store other keys in 239 the future. 240 241 This is the dictionary object that represents a single AuthorizedKey in Arvados 242 and is returned by most `AuthorizedKeys` methods. 243 The keys of the dictionary are documented below, along with their types. 244 Not every key may appear in every dictionary returned by an API call. 245 When a method doesn't return all the data, you can use its `select` parameter 246 to list the specific keys you need. Refer to the API documentation for details. 247 """ 248 etag: 'str' 249 """Object cache version.""" 250 uuid: 'str' 251 """This authorized key's Arvados UUID, like `zzzzz-fngyi-12345abcde67890`.""" 252 owner_uuid: 'str' 253 """The UUID of the user or group that owns this authorized key.""" 254 modified_by_user_uuid: 'str' 255 """The UUID of the user that last updated this authorized key.""" 256 modified_at: 'str' 257 """The time this authorized key was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 258 name: 'str' 259 """The name of this authorized key assigned by a user.""" 260 key_type: 'str' 261 """A string identifying what type of service uses this key. Supported values are: 262 263 * `"SSH"` 264 """ 265 authorized_user_uuid: 'str' 266 """The UUID of the Arvados user that is authorized by this key.""" 267 public_key: 'str' 268 """The full public key, in the format referenced by `key_type`.""" 269 expires_at: 'str' 270 """The time after which this key is no longer valid for authorization. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 271 created_at: 'str' 272 """The time this authorized key was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 273 274 275class AuthorizedKeyList(TypedDict, total=False): 276 """A list of AuthorizedKey objects. 277 278 This is the dictionary object returned when you call `AuthorizedKeys.list`. 279 If you just want to iterate all objects that match your search criteria, 280 consider using `arvados.util.keyset_list_all`. 281 If you work with this raw object, the keys of the dictionary are documented 282 below, along with their types. The `items` key maps to a list of matching 283 `AuthorizedKey` objects. 284 """ 285 kind: 'str' = 'arvados#authorizedKeyList' 286 """Object type. Always arvados#authorizedKeyList.""" 287 etag: 'str' 288 """List cache version.""" 289 items: 'List[AuthorizedKey]' 290 """An array of matching AuthorizedKey objects.""" 291 292 293class AuthorizedKeys: 294 """Methods to query and manipulate Arvados authorized keys""" 295 296 def create(self, *, body: "Dict[Literal['authorized_key'], AuthorizedKey]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[AuthorizedKey]': 297 """Create a new AuthorizedKey. 298 299 Required parameters: 300 301 * body: Dict[Literal['authorized_key'], AuthorizedKey] --- A dictionary with a single item `'authorized_key'`. 302 Its value is a `AuthorizedKey` dictionary defining the attributes to set. 303 304 Optional parameters: 305 306 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 307 308 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 309 310 * select: Optional[List] --- An array of names of attributes to return in the response. 311 """ 312 313 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[AuthorizedKey]': 314 """Delete an existing AuthorizedKey. 315 316 Required parameters: 317 318 * uuid: str --- The UUID of the AuthorizedKey to delete. 319 """ 320 321 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[AuthorizedKey]': 322 """Get a AuthorizedKey record by UUID. 323 324 Required parameters: 325 326 * uuid: str --- The UUID of the AuthorizedKey to return. 327 328 Optional parameters: 329 330 * select: Optional[List] --- An array of names of attributes to return in the response. 331 """ 332 333 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[AuthorizedKeyList]': 334 """Retrieve a AuthorizedKeyList. 335 336 This method returns a single page of `AuthorizedKey` objects that match your search 337 criteria. If you just want to iterate all objects that match your search 338 criteria, consider using `arvados.util.keyset_list_all`. 339 340 Optional parameters: 341 342 * bypass_federation: bool --- If true, do not return results from other clusters in the 343 federation, only the cluster that received the request. 344 You must be an administrator to use this flag. Default `False`. 345 346 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 347 348 * count: str --- A string to determine result counting behavior. Supported values are: 349 350 * `"exact"`: The response will include an `items_available` field that 351 counts the number of objects that matched this search criteria, 352 including ones not included in `items`. 353 354 * `"none"`: The response will not include an `items_avaliable` 355 field. This improves performance by returning a result as soon as enough 356 `items` have been loaded for this result. 357 358 Default `'exact'`. 359 360 * distinct: bool --- If this is true, and multiple objects have the same values 361 for the attributes that you specify in the `select` parameter, then each unique 362 set of values will only be returned once in the result set. Default `False`. 363 364 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 365 Refer to the [filters reference][] for more information about how to write filters. 366 367 [filters reference]: https://doc.arvados.org/api/methods.html#filters 368 369 * limit: int --- The maximum number of objects to return in the result. 370 Note that the API may return fewer results than this if your request hits other 371 limits set by the administrator. Default `100`. 372 373 * offset: int --- Return matching objects starting from this index. 374 Note that result indexes may change if objects are modified in between a series 375 of list calls. Default `0`. 376 377 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 378 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 379 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 380 381 * select: Optional[List] --- An array of names of attributes to return from each matching object. 382 383 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 384 The keys of this object are attribute names. 385 Each value is either a single matching value or an array of matching values for that attribute. 386 The `filters` parameter is more flexible and preferred. 387 """ 388 389 def update(self, *, body: "Dict[Literal['authorized_key'], AuthorizedKey]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[AuthorizedKey]': 390 """Update attributes of an existing AuthorizedKey. 391 392 Required parameters: 393 394 * body: Dict[Literal['authorized_key'], AuthorizedKey] --- A dictionary with a single item `'authorized_key'`. 395 Its value is a `AuthorizedKey` dictionary defining the attributes to set. 396 397 * uuid: str --- The UUID of the AuthorizedKey to update. 398 399 Optional parameters: 400 401 * select: Optional[List] --- An array of names of attributes to return in the response. 402 """ 403 404 405class Collection(TypedDict, total=False): 406 """Arvados data collection 407 408 A collection describes how a set of files is stored in data blocks in Keep, 409 along with associated metadata. 410 411 This is the dictionary object that represents a single Collection in Arvados 412 and is returned by most `Collections` methods. 413 The keys of the dictionary are documented below, along with their types. 414 Not every key may appear in every dictionary returned by an API call. 415 When a method doesn't return all the data, you can use its `select` parameter 416 to list the specific keys you need. Refer to the API documentation for details. 417 """ 418 etag: 'str' 419 """Object cache version.""" 420 owner_uuid: 'str' 421 """The UUID of the user or group that owns this collection.""" 422 created_at: 'str' 423 """The time this collection was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 424 modified_by_user_uuid: 'str' 425 """The UUID of the user that last updated this collection.""" 426 modified_at: 'str' 427 """The time this collection was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 428 portable_data_hash: 'str' 429 """The portable data hash of this collection. This string provides a unique 430 and stable reference to these contents. 431 """ 432 replication_desired: 'int' 433 """The number of copies that should be made for data in this collection.""" 434 replication_confirmed_at: 'str' 435 """The last time the cluster confirmed that it met `replication_confirmed` 436 for this collection. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`. 437 """ 438 replication_confirmed: 'int' 439 """The number of copies of data in this collection that the cluster has confirmed 440 exist in storage. 441 """ 442 uuid: 'str' 443 """This collection's Arvados UUID, like `zzzzz-4zz18-12345abcde67890`.""" 444 manifest_text: 'str' 445 """The manifest text that describes how files are constructed from data blocks 446 in this collection. Refer to the [manifest format][] reference for details. 447 448 [manifest format]: https://doc.arvados.org/architecture/manifest-format.html 449 """ 450 name: 'str' 451 """The name of this collection assigned by a user.""" 452 description: 'str' 453 """A longer HTML description of this collection assigned by a user. 454 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 455 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 456 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 457 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 458 """ 459 properties: 'Dict[str, Any]' 460 """A hash of arbitrary metadata for this collection. 461 Some keys may be reserved by Arvados or defined by a configured vocabulary. 462 Refer to the [metadata properties reference][] for details. 463 464 [metadata properties reference]: https://doc.arvados.org/api/properties.html 465 """ 466 delete_at: 'str' 467 """The time this collection will be permanently deleted. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 468 trash_at: 'str' 469 """The time this collection will be trashed. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 470 is_trashed: 'bool' 471 """A boolean flag to indicate whether or not this collection is trashed.""" 472 storage_classes_desired: 'List' 473 """An array of strings identifying the storage class(es) that should be used 474 for data in this collection. Storage classes are configured by the cluster administrator. 475 """ 476 storage_classes_confirmed: 'List' 477 """An array of strings identifying the storage class(es) the cluster has 478 confirmed have a copy of this collection's data. 479 """ 480 storage_classes_confirmed_at: 'str' 481 """The last time the cluster confirmed that data was stored on the storage 482 class(es) in `storage_classes_confirmed`. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`. 483 """ 484 current_version_uuid: 'str' 485 """The UUID of the current version of this collection.""" 486 version: 'int' 487 """An integer that counts which version of a collection this record 488 represents. Refer to [collection versioning][] for details. This attribute is 489 read-only. 490 491 [collection versioning]: https://doc.arvados.org/user/topics/collection-versioning.html 492 """ 493 preserve_version: 'bool' 494 """A boolean flag to indicate whether this specific version of this collection 495 should be persisted in cluster storage. 496 """ 497 file_count: 'int' 498 """The number of files represented in this collection's `manifest_text`. 499 This attribute is read-only. 500 """ 501 file_size_total: 'int' 502 """The total size in bytes of files represented in this collection's `manifest_text`. 503 This attribute is read-only. 504 """ 505 506 507class CollectionList(TypedDict, total=False): 508 """A list of Collection objects. 509 510 This is the dictionary object returned when you call `Collections.list`. 511 If you just want to iterate all objects that match your search criteria, 512 consider using `arvados.util.keyset_list_all`. 513 If you work with this raw object, the keys of the dictionary are documented 514 below, along with their types. The `items` key maps to a list of matching 515 `Collection` objects. 516 """ 517 kind: 'str' = 'arvados#collectionList' 518 """Object type. Always arvados#collectionList.""" 519 etag: 'str' 520 """List cache version.""" 521 items: 'List[Collection]' 522 """An array of matching Collection objects.""" 523 524 525class Collections: 526 """Methods to query and manipulate Arvados collections""" 527 528 def create(self, *, body: "Dict[Literal['collection'], Collection]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, replace_files: 'Optional[Dict[str, Any]]' = None, replace_segments: 'Optional[Dict[str, Any]]' = None, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 529 """Create a new Collection. 530 531 Required parameters: 532 533 * body: Dict[Literal['collection'], Collection] --- A dictionary with a single item `'collection'`. 534 Its value is a `Collection` dictionary defining the attributes to set. 535 536 Optional parameters: 537 538 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 539 540 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 541 542 * replace_files: Optional[Dict[str, Any]] --- Add, delete, and replace files and directories with new content 543 and/or content from other collections. Refer to the 544 [replace_files reference][] for details. 545 546 [replace_files reference]: https://doc.arvados.org/api/methods/collections.html#replace_files 547 548 * replace_segments: Optional[Dict[str, Any]] --- Replace existing block segments in the collection with new segments. 549 Refer to the [replace_segments reference][] for details. 550 551 [replace_segments reference]: https://doc.arvados.org/api/methods/collections.html#replace_segments 552 553 * select: Optional[List] --- An array of names of attributes to return in the response. 554 """ 555 556 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 557 """Delete an existing Collection. 558 559 Required parameters: 560 561 * uuid: str --- The UUID of the Collection to delete. 562 """ 563 564 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 565 """Get a Collection record by UUID. 566 567 Required parameters: 568 569 * uuid: str --- The UUID of the Collection to return. 570 571 Optional parameters: 572 573 * include_trash: bool --- Show collection even if its `is_trashed` attribute is true. Default `False`. 574 575 * select: Optional[List] --- An array of names of attributes to return in the response. 576 """ 577 578 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, include_old_versions: 'bool' = False, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[CollectionList]': 579 """Retrieve a CollectionList. 580 581 This method returns a single page of `Collection` objects that match your search 582 criteria. If you just want to iterate all objects that match your search 583 criteria, consider using `arvados.util.keyset_list_all`. 584 585 Optional parameters: 586 587 * bypass_federation: bool --- If true, do not return results from other clusters in the 588 federation, only the cluster that received the request. 589 You must be an administrator to use this flag. Default `False`. 590 591 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 592 593 * count: str --- A string to determine result counting behavior. Supported values are: 594 595 * `"exact"`: The response will include an `items_available` field that 596 counts the number of objects that matched this search criteria, 597 including ones not included in `items`. 598 599 * `"none"`: The response will not include an `items_avaliable` 600 field. This improves performance by returning a result as soon as enough 601 `items` have been loaded for this result. 602 603 Default `'exact'`. 604 605 * distinct: bool --- If this is true, and multiple objects have the same values 606 for the attributes that you specify in the `select` parameter, then each unique 607 set of values will only be returned once in the result set. Default `False`. 608 609 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 610 Refer to the [filters reference][] for more information about how to write filters. 611 612 [filters reference]: https://doc.arvados.org/api/methods.html#filters 613 614 * include_old_versions: bool --- Include past collection versions. Default `False`. 615 616 * include_trash: bool --- Include collections whose `is_trashed` attribute is true. Default `False`. 617 618 * limit: int --- The maximum number of objects to return in the result. 619 Note that the API may return fewer results than this if your request hits other 620 limits set by the administrator. Default `100`. 621 622 * offset: int --- Return matching objects starting from this index. 623 Note that result indexes may change if objects are modified in between a series 624 of list calls. Default `0`. 625 626 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 627 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 628 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 629 630 * select: Optional[List] --- An array of names of attributes to return from each matching object. 631 632 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 633 The keys of this object are attribute names. 634 Each value is either a single matching value or an array of matching values for that attribute. 635 The `filters` parameter is more flexible and preferred. 636 """ 637 638 def provenance(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 639 """Detail the provenance of a given collection. 640 641 Required parameters: 642 643 * uuid: str --- The UUID of the Collection to query. 644 """ 645 646 def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 647 """Trash a collection. 648 649 Required parameters: 650 651 * uuid: str --- The UUID of the Collection to update. 652 """ 653 654 def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 655 """Untrash a collection. 656 657 Required parameters: 658 659 * uuid: str --- The UUID of the Collection to update. 660 """ 661 662 def update(self, *, body: "Dict[Literal['collection'], Collection]", uuid: 'str', replace_files: 'Optional[Dict[str, Any]]' = None, replace_segments: 'Optional[Dict[str, Any]]' = None, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 663 """Update attributes of an existing Collection. 664 665 Required parameters: 666 667 * body: Dict[Literal['collection'], Collection] --- A dictionary with a single item `'collection'`. 668 Its value is a `Collection` dictionary defining the attributes to set. 669 670 * uuid: str --- The UUID of the Collection to update. 671 672 Optional parameters: 673 674 * replace_files: Optional[Dict[str, Any]] --- Add, delete, and replace files and directories with new content 675 and/or content from other collections. Refer to the 676 [replace_files reference][] for details. 677 678 [replace_files reference]: https://doc.arvados.org/api/methods/collections.html#replace_files 679 680 * replace_segments: Optional[Dict[str, Any]] --- Replace existing block segments in the collection with new segments. 681 Refer to the [replace_segments reference][] for details. 682 683 [replace_segments reference]: https://doc.arvados.org/api/methods/collections.html#replace_segments 684 685 * select: Optional[List] --- An array of names of attributes to return in the response. 686 """ 687 688 def used_by(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 689 """Detail where a given collection has been used. 690 691 Required parameters: 692 693 * uuid: str --- The UUID of the Collection to query. 694 """ 695 696 697class ComputedPermission(TypedDict, total=False): 698 """Arvados computed permission 699 700 Computed permissions do not correspond directly to any Arvados resource, but 701 provide a simple way to query the entire graph of permissions granted to 702 users and groups. 703 704 This is the dictionary object that represents a single ComputedPermission in Arvados 705 and is returned by most `ComputedPermissions` methods. 706 The keys of the dictionary are documented below, along with their types. 707 Not every key may appear in every dictionary returned by an API call. 708 When a method doesn't return all the data, you can use its `select` parameter 709 to list the specific keys you need. Refer to the API documentation for details. 710 """ 711 user_uuid: 'str' 712 """The UUID of the Arvados user who has this permission.""" 713 target_uuid: 'str' 714 """The UUID of the Arvados object the user has access to.""" 715 perm_level: 'str' 716 """A string representing the user's level of access to the target object. 717 Possible values are: 718 719 * `"can_read"` 720 * `"can_write"` 721 * `"can_manage"` 722 """ 723 724 725class ComputedPermissionList(TypedDict, total=False): 726 """A list of ComputedPermission objects. 727 728 This is the dictionary object returned when you call `ComputedPermissions.list`. 729 If you just want to iterate all objects that match your search criteria, 730 consider using `arvados.util.iter_computed_permissions`. 731 If you work with this raw object, the keys of the dictionary are documented 732 below, along with their types. The `items` key maps to a list of matching 733 `ComputedPermission` objects. 734 """ 735 kind: 'str' = 'arvados#computedPermissionList' 736 """Object type. Always arvados#computedPermissionList.""" 737 etag: 'str' 738 """List cache version.""" 739 items: 'List[ComputedPermission]' 740 """An array of matching ComputedPermission objects.""" 741 742 743class ComputedPermissions: 744 """Methods to query and manipulate Arvados computed permissions""" 745 746 def list(self, *, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[ComputedPermissionList]': 747 """Retrieve a ComputedPermissionList. 748 749 This method returns a single page of `ComputedPermission` objects that match your search 750 criteria. If you just want to iterate all objects that match your search 751 criteria, consider using `arvados.util.iter_computed_permissions`. 752 753 Optional parameters: 754 755 * count: str --- A string to determine result counting behavior. Supported values are: 756 757 * `"exact"`: The response will include an `items_available` field that 758 counts the number of objects that matched this search criteria, 759 including ones not included in `items`. 760 761 * `"none"`: The response will not include an `items_avaliable` 762 field. This improves performance by returning a result as soon as enough 763 `items` have been loaded for this result. 764 765 Default `'exact'`. 766 767 * distinct: bool --- If this is true, and multiple objects have the same values 768 for the attributes that you specify in the `select` parameter, then each unique 769 set of values will only be returned once in the result set. Default `False`. 770 771 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 772 Refer to the [filters reference][] for more information about how to write filters. 773 774 [filters reference]: https://doc.arvados.org/api/methods.html#filters 775 776 * limit: int --- The maximum number of objects to return in the result. 777 Note that the API may return fewer results than this if your request hits other 778 limits set by the administrator. Default `100`. 779 780 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 781 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 782 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 783 784 * select: Optional[List] --- An array of names of attributes to return from each matching object. 785 786 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 787 The keys of this object are attribute names. 788 Each value is either a single matching value or an array of matching values for that attribute. 789 The `filters` parameter is more flexible and preferred. 790 """ 791 792 793class Configs: 794 """Methods to query and manipulate Arvados configs""" 795 796 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 797 """Get this cluster's public configuration settings.""" 798 799 800class ContainerRequest(TypedDict, total=False): 801 """Arvados container request 802 803 A container request represents a user's request that Arvados do some compute 804 work, along with full details about what work should be done. Arvados will 805 attempt to fulfill the request by mapping it to a matching container record, 806 running the work on demand if necessary. 807 808 This is the dictionary object that represents a single ContainerRequest in Arvados 809 and is returned by most `ContainerRequests` methods. 810 The keys of the dictionary are documented below, along with their types. 811 Not every key may appear in every dictionary returned by an API call. 812 When a method doesn't return all the data, you can use its `select` parameter 813 to list the specific keys you need. Refer to the API documentation for details. 814 """ 815 etag: 'str' 816 """Object cache version.""" 817 uuid: 'str' 818 """This container request's Arvados UUID, like `zzzzz-xvhdp-12345abcde67890`.""" 819 owner_uuid: 'str' 820 """The UUID of the user or group that owns this container request.""" 821 created_at: 'str' 822 """The time this container request was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 823 modified_at: 'str' 824 """The time this container request was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 825 modified_by_user_uuid: 'str' 826 """The UUID of the user that last updated this container request.""" 827 name: 'str' 828 """The name of this container request assigned by a user.""" 829 description: 'str' 830 """A longer HTML description of this container request assigned by a user. 831 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 832 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 833 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 834 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 835 """ 836 properties: 'Dict[str, Any]' 837 """A hash of arbitrary metadata for this container request. 838 Some keys may be reserved by Arvados or defined by a configured vocabulary. 839 Refer to the [metadata properties reference][] for details. 840 841 [metadata properties reference]: https://doc.arvados.org/api/properties.html 842 """ 843 state: 'str' 844 """A string indicating where this container request is in its lifecycle. 845 Possible values are: 846 847 * `"Uncommitted"` --- The container request has not been finalized and can still be edited. 848 * `"Committed"` --- The container request is ready to be fulfilled. 849 * `"Final"` --- The container request has been fulfilled or cancelled. 850 """ 851 requesting_container_uuid: 'str' 852 """The UUID of the container that created this container request, if any.""" 853 container_uuid: 'str' 854 """The UUID of the container that fulfills this container request, if any.""" 855 container_count_max: 'int' 856 """An integer that defines the maximum number of times Arvados should attempt 857 to dispatch a container to fulfill this container request. 858 """ 859 mounts: 'Dict[str, Any]' 860 """A hash where each key names a directory inside this container, and its 861 value is an object that defines the mount source for that directory. Refer 862 to the [mount types reference][] for details. 863 864 [mount types reference]: https://doc.arvados.org/api/methods/containers.html#mount_types 865 """ 866 runtime_constraints: 'Dict[str, Any]' 867 """A hash that identifies compute resources this container requires to run 868 successfully. See the [runtime constraints reference][] for details. 869 870 [runtime constraints reference]: https://doc.arvados.org/api/methods/containers.html#runtime_constraints 871 """ 872 container_image: 'str' 873 """The portable data hash of the Arvados collection that contains the image 874 to use for this container. 875 """ 876 environment: 'Dict[str, Any]' 877 """A hash of string keys and values that defines the environment variables 878 for the dispatcher to set when it executes this container. 879 """ 880 cwd: 'str' 881 """A string that the defines the working directory that the dispatcher should 882 use when it executes the command inside this container. 883 """ 884 command: 'List' 885 """An array of strings that defines the command that the dispatcher should 886 execute inside this container. 887 """ 888 output_path: 'str' 889 """A string that defines the file or directory path where the command 890 writes output that should be saved from this container. 891 """ 892 priority: 'int' 893 """An integer between 0 and 1000 (inclusive) that represents this container request's 894 scheduling priority. 0 represents a request to be cancelled. Higher 895 values represent higher priority. Refer to the [priority reference][] for details. 896 897 [priority reference]: https://doc.arvados.org/api/methods/container_requests.html#priority 898 """ 899 expires_at: 'str' 900 """The time after which this container request will no longer be fulfilled. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 901 filters: 'str' 902 """Filters that limit which existing containers are eligible to satisfy this 903 container request. This attribute is not implemented yet and should be null. 904 """ 905 container_count: 'int' 906 """An integer that records how many times Arvados has attempted to dispatch 907 a container to fulfill this container request. 908 """ 909 use_existing: 'bool' 910 """A boolean flag. If set, Arvados may choose to satisfy this container 911 request with an eligible container that already exists. Otherwise, Arvados will 912 satisfy this container request with a newer container, which will usually result 913 in the container running again. 914 """ 915 scheduling_parameters: 'Dict[str, Any]' 916 """A hash of scheduling parameters that should be passed to the underlying 917 dispatcher when this container is run. 918 See the [scheduling parameters reference][] for details. 919 920 [scheduling parameters reference]: https://doc.arvados.org/api/methods/containers.html#scheduling_parameters 921 """ 922 output_uuid: 'str' 923 """The UUID of the Arvados collection that contains output for all the 924 container(s) that were dispatched to fulfill this container request. 925 """ 926 log_uuid: 'str' 927 """The UUID of the Arvados collection that contains logs for all the 928 container(s) that were dispatched to fulfill this container request. 929 """ 930 output_name: 'str' 931 """The name to set on the output collection of this container request.""" 932 output_ttl: 'int' 933 """An integer in seconds. If greater than zero, when an output collection is 934 created for this container request, its `expires_at` attribute will be set this 935 far in the future. 936 """ 937 output_storage_classes: 'List' 938 """An array of strings identifying the storage class(es) that should be set 939 on the output collection of this container request. Storage classes are configured by 940 the cluster administrator. 941 """ 942 output_properties: 'Dict[str, Any]' 943 """A hash of arbitrary metadata to set on the output collection of this container request. 944 Some keys may be reserved by Arvados or defined by a configured vocabulary. 945 Refer to the [metadata properties reference][] for details. 946 947 [metadata properties reference]: https://doc.arvados.org/api/properties.html 948 """ 949 cumulative_cost: 'float' 950 """A float with the estimated cost of all cloud instances used to run 951 container(s) to fulfill this container request and their subrequests. 952 The value is `0` if cost estimation is not available on this cluster. 953 """ 954 output_glob: 'List' 955 """An array of strings of shell-style glob patterns that define which file(s) 956 and subdirectory(ies) under the `output_path` directory should be recorded in 957 the container's final output. Refer to the [glob patterns reference][] for details. 958 959 [glob patterns reference]: https://doc.arvados.org/api/methods/containers.html#glob_patterns 960 """ 961 service: 'bool' 962 """A boolean flag. If set, it informs the system that this request is for a long-running container 963 that functions as a system service or web app, rather than a once-through batch operation. 964 """ 965 published_ports: 'Dict[str, Any]' 966 """A hash where keys are numeric TCP ports on the container which expose HTTP services. Arvados 967 will proxy HTTP requests to these ports. Values are hashes with the following keys: 968 969 * `"access"` --- One of 'private' or 'public' indicating if an Arvados API token is required to access the endpoint. 970 * `"label"` --- A human readable label describing the service, for display in Workbench. 971 * `"initial_path"` --- The relative path that should be included when constructing the URL that will be presented to the user in Workbench. 972 """ 973 974 975class ContainerRequestList(TypedDict, total=False): 976 """A list of ContainerRequest objects. 977 978 This is the dictionary object returned when you call `ContainerRequests.list`. 979 If you just want to iterate all objects that match your search criteria, 980 consider using `arvados.util.keyset_list_all`. 981 If you work with this raw object, the keys of the dictionary are documented 982 below, along with their types. The `items` key maps to a list of matching 983 `ContainerRequest` objects. 984 """ 985 kind: 'str' = 'arvados#containerRequestList' 986 """Object type. Always arvados#containerRequestList.""" 987 etag: 'str' 988 """List cache version.""" 989 items: 'List[ContainerRequest]' 990 """An array of matching ContainerRequest objects.""" 991 992 993class ContainerRequests: 994 """Methods to query and manipulate Arvados container requests""" 995 996 def container_status(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]': 997 """Return scheduling details for a container request. 998 999 Required parameters: 1000 1001 * uuid: str --- The UUID of the container request to query. 1002 """ 1003 1004 def create(self, *, body: "Dict[Literal['container_request'], ContainerRequest]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1005 """Create a new ContainerRequest. 1006 1007 Required parameters: 1008 1009 * body: Dict[Literal['container_request'], ContainerRequest] --- A dictionary with a single item `'container_request'`. 1010 Its value is a `ContainerRequest` dictionary defining the attributes to set. 1011 1012 Optional parameters: 1013 1014 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1015 1016 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 1017 1018 * select: Optional[List] --- An array of names of attributes to return in the response. 1019 """ 1020 1021 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]': 1022 """Delete an existing ContainerRequest. 1023 1024 Required parameters: 1025 1026 * uuid: str --- The UUID of the ContainerRequest to delete. 1027 """ 1028 1029 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1030 """Get a ContainerRequest record by UUID. 1031 1032 Required parameters: 1033 1034 * uuid: str --- The UUID of the ContainerRequest to return. 1035 1036 Optional parameters: 1037 1038 * include_trash: bool --- Show container request even if its owner project is trashed. Default `False`. 1039 1040 * select: Optional[List] --- An array of names of attributes to return in the response. 1041 """ 1042 1043 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[ContainerRequestList]': 1044 """Retrieve a ContainerRequestList. 1045 1046 This method returns a single page of `ContainerRequest` objects that match your search 1047 criteria. If you just want to iterate all objects that match your search 1048 criteria, consider using `arvados.util.keyset_list_all`. 1049 1050 Optional parameters: 1051 1052 * bypass_federation: bool --- If true, do not return results from other clusters in the 1053 federation, only the cluster that received the request. 1054 You must be an administrator to use this flag. Default `False`. 1055 1056 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1057 1058 * count: str --- A string to determine result counting behavior. Supported values are: 1059 1060 * `"exact"`: The response will include an `items_available` field that 1061 counts the number of objects that matched this search criteria, 1062 including ones not included in `items`. 1063 1064 * `"none"`: The response will not include an `items_avaliable` 1065 field. This improves performance by returning a result as soon as enough 1066 `items` have been loaded for this result. 1067 1068 Default `'exact'`. 1069 1070 * distinct: bool --- If this is true, and multiple objects have the same values 1071 for the attributes that you specify in the `select` parameter, then each unique 1072 set of values will only be returned once in the result set. Default `False`. 1073 1074 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1075 Refer to the [filters reference][] for more information about how to write filters. 1076 1077 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1078 1079 * include_trash: bool --- Include container requests whose owner project is trashed. Default `False`. 1080 1081 * limit: int --- The maximum number of objects to return in the result. 1082 Note that the API may return fewer results than this if your request hits other 1083 limits set by the administrator. Default `100`. 1084 1085 * offset: int --- Return matching objects starting from this index. 1086 Note that result indexes may change if objects are modified in between a series 1087 of list calls. Default `0`. 1088 1089 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1090 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1091 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1092 1093 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1094 1095 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1096 The keys of this object are attribute names. 1097 Each value is either a single matching value or an array of matching values for that attribute. 1098 The `filters` parameter is more flexible and preferred. 1099 """ 1100 1101 def update(self, *, body: "Dict[Literal['container_request'], ContainerRequest]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1102 """Update attributes of an existing ContainerRequest. 1103 1104 Required parameters: 1105 1106 * body: Dict[Literal['container_request'], ContainerRequest] --- A dictionary with a single item `'container_request'`. 1107 Its value is a `ContainerRequest` dictionary defining the attributes to set. 1108 1109 * uuid: str --- The UUID of the ContainerRequest to update. 1110 1111 Optional parameters: 1112 1113 * select: Optional[List] --- An array of names of attributes to return in the response. 1114 """ 1115 1116 1117class Container(TypedDict, total=False): 1118 """Arvados container record 1119 1120 A container represents compute work that has been or should be dispatched, 1121 along with its results. A container can satisfy one or more container requests. 1122 1123 This is the dictionary object that represents a single Container in Arvados 1124 and is returned by most `Containers` methods. 1125 The keys of the dictionary are documented below, along with their types. 1126 Not every key may appear in every dictionary returned by an API call. 1127 When a method doesn't return all the data, you can use its `select` parameter 1128 to list the specific keys you need. Refer to the API documentation for details. 1129 """ 1130 etag: 'str' 1131 """Object cache version.""" 1132 uuid: 'str' 1133 """This container's Arvados UUID, like `zzzzz-dz642-12345abcde67890`.""" 1134 owner_uuid: 'str' 1135 """The UUID of the user or group that owns this container.""" 1136 created_at: 'str' 1137 """The time this container was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1138 modified_at: 'str' 1139 """The time this container was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1140 modified_by_user_uuid: 'str' 1141 """The UUID of the user that last updated this container.""" 1142 state: 'str' 1143 """A string representing the container's current execution status. Possible 1144 values are: 1145 1146 * `"Queued"` --- This container has not been dispatched yet. 1147 * `"Locked"` --- A dispatcher has claimed this container in preparation to run it. 1148 * `"Running"` --- A dispatcher is running this container. 1149 * `"Cancelled"` --- Container execution has been cancelled by user request. 1150 * `"Complete"` --- A dispatcher ran this container to completion and recorded the results. 1151 """ 1152 started_at: 'str' 1153 """The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1154 finished_at: 'str' 1155 """The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1156 log: 'str' 1157 """The portable data hash of the Arvados collection that contains this 1158 container's logs. 1159 """ 1160 environment: 'Dict[str, Any]' 1161 """A hash of string keys and values that defines the environment variables 1162 for the dispatcher to set when it executes this container. 1163 """ 1164 cwd: 'str' 1165 """A string that the defines the working directory that the dispatcher should 1166 use when it executes the command inside this container. 1167 """ 1168 command: 'List' 1169 """An array of strings that defines the command that the dispatcher should 1170 execute inside this container. 1171 """ 1172 output_path: 'str' 1173 """A string that defines the file or directory path where the command 1174 writes output that should be saved from this container. 1175 """ 1176 mounts: 'Dict[str, Any]' 1177 """A hash where each key names a directory inside this container, and its 1178 value is an object that defines the mount source for that directory. Refer 1179 to the [mount types reference][] for details. 1180 1181 [mount types reference]: https://doc.arvados.org/api/methods/containers.html#mount_types 1182 """ 1183 runtime_constraints: 'Dict[str, Any]' 1184 """A hash that identifies compute resources this container requires to run 1185 successfully. See the [runtime constraints reference][] for details. 1186 1187 [runtime constraints reference]: https://doc.arvados.org/api/methods/containers.html#runtime_constraints 1188 """ 1189 output: 'str' 1190 """The portable data hash of the Arvados collection that contains this 1191 container's output file(s). 1192 """ 1193 container_image: 'str' 1194 """The portable data hash of the Arvados collection that contains the image 1195 to use for this container. 1196 """ 1197 progress: 'float' 1198 """A float between 0.0 and 1.0 (inclusive) that represents the container's 1199 execution progress. This attribute is not implemented yet. 1200 """ 1201 priority: 'int' 1202 """An integer between 0 and 1000 (inclusive) that represents this container's 1203 scheduling priority. 0 represents a request to be cancelled. Higher 1204 values represent higher priority. Refer to the [priority reference][] for details. 1205 1206 [priority reference]: https://doc.arvados.org/api/methods/container_requests.html#priority 1207 """ 1208 exit_code: 'int' 1209 """An integer that records the Unix exit code of the `command` from a 1210 finished container. 1211 """ 1212 auth_uuid: 'str' 1213 """The UUID of the Arvados API client authorization token that a dispatcher 1214 should use to set up this container. This token is automatically created by 1215 Arvados and this attribute automatically assigned unless a container is 1216 created with `runtime_token`. 1217 """ 1218 locked_by_uuid: 'str' 1219 """The UUID of the Arvados API client authorization token that successfully 1220 locked this container in preparation to execute it. 1221 """ 1222 scheduling_parameters: 'Dict[str, Any]' 1223 """A hash of scheduling parameters that should be passed to the underlying 1224 dispatcher when this container is run. 1225 See the [scheduling parameters reference][] for details. 1226 1227 [scheduling parameters reference]: https://doc.arvados.org/api/methods/containers.html#scheduling_parameters 1228 """ 1229 runtime_status: 'Dict[str, Any]' 1230 """A hash with status updates from a running container. 1231 Refer to the [runtime status reference][] for details. 1232 1233 [runtime status reference]: https://doc.arvados.org/api/methods/containers.html#runtime_status 1234 """ 1235 runtime_user_uuid: 'str' 1236 """The UUID of the Arvados user associated with the API client authorization 1237 token used to run this container. 1238 """ 1239 runtime_auth_scopes: 'List' 1240 """The `scopes` from the API client authorization token used to run this container.""" 1241 lock_count: 'int' 1242 """The number of times this container has been locked by a dispatcher. This 1243 may be greater than 1 if a dispatcher locks a container but then execution is 1244 interrupted for any reason. 1245 """ 1246 gateway_address: 'str' 1247 """A string with the address of the Arvados gateway server, in `HOST:PORT` 1248 format. This is for internal use only. 1249 """ 1250 interactive_session_started: 'bool' 1251 """This flag is set true if any user starts an interactive shell inside the 1252 running container. 1253 """ 1254 output_storage_classes: 'List' 1255 """An array of strings identifying the storage class(es) that should be set 1256 on the output collection of this container. Storage classes are configured by 1257 the cluster administrator. 1258 """ 1259 output_properties: 'Dict[str, Any]' 1260 """A hash of arbitrary metadata to set on the output collection of this container. 1261 Some keys may be reserved by Arvados or defined by a configured vocabulary. 1262 Refer to the [metadata properties reference][] for details. 1263 1264 [metadata properties reference]: https://doc.arvados.org/api/properties.html 1265 """ 1266 cost: 'float' 1267 """A float with the estimated cost of the cloud instance used to run this 1268 container. The value is `0` if cost estimation is not available on this cluster. 1269 """ 1270 subrequests_cost: 'float' 1271 """A float with the estimated cost of all cloud instances used to run this 1272 container and all its subrequests. The value is `0` if cost estimation is not 1273 available on this cluster. 1274 """ 1275 output_glob: 'List' 1276 """An array of strings of shell-style glob patterns that define which file(s) 1277 and subdirectory(ies) under the `output_path` directory should be recorded in 1278 the container's final output. Refer to the [glob patterns reference][] for details. 1279 1280 [glob patterns reference]: https://doc.arvados.org/api/methods/containers.html#glob_patterns 1281 """ 1282 service: 'bool' 1283 """A boolean flag. If set, it informs the system that this is a long-running container 1284 that functions as a system service or web app, rather than a once-through batch operation. 1285 """ 1286 published_ports: 'jsonb' 1287 """A hash where keys are numeric TCP ports on the container which expose HTTP services. Arvados 1288 will proxy HTTP requests to these ports. Values are hashes with the following keys: 1289 1290 * `"access"` --- One of 'private' or 'public' indicating if an Arvados API token is required to access the endpoint. 1291 * `"label"` --- A human readable label describing the service, for display in Workbench. 1292 * `"initial_path"` --- The relative path that should be included when constructing the URL that will be presented to the user in Workbench. 1293 """ 1294 1295 1296class ContainerList(TypedDict, total=False): 1297 """A list of Container objects. 1298 1299 This is the dictionary object returned when you call `Containers.list`. 1300 If you just want to iterate all objects that match your search criteria, 1301 consider using `arvados.util.keyset_list_all`. 1302 If you work with this raw object, the keys of the dictionary are documented 1303 below, along with their types. The `items` key maps to a list of matching 1304 `Container` objects. 1305 """ 1306 kind: 'str' = 'arvados#containerList' 1307 """Object type. Always arvados#containerList.""" 1308 etag: 'str' 1309 """List cache version.""" 1310 items: 'List[Container]' 1311 """An array of matching Container objects.""" 1312 1313 1314class Containers: 1315 """Methods to query and manipulate Arvados containers""" 1316 1317 def auth(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1318 """Get the API client authorization token associated with this container. 1319 1320 Required parameters: 1321 1322 * uuid: str --- The UUID of the Container to query. 1323 """ 1324 1325 def create(self, *, body: "Dict[Literal['container'], Container]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1326 """Create a new Container. 1327 1328 Required parameters: 1329 1330 * body: Dict[Literal['container'], Container] --- A dictionary with a single item `'container'`. 1331 Its value is a `Container` dictionary defining the attributes to set. 1332 1333 Optional parameters: 1334 1335 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1336 1337 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 1338 1339 * select: Optional[List] --- An array of names of attributes to return in the response. 1340 """ 1341 1342 def current(self) -> 'ArvadosAPIRequest[Container]': 1343 """Return the container record associated with the API token authorizing this request.""" 1344 1345 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1346 """Delete an existing Container. 1347 1348 Required parameters: 1349 1350 * uuid: str --- The UUID of the Container to delete. 1351 """ 1352 1353 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1354 """Get a Container record by UUID. 1355 1356 Required parameters: 1357 1358 * uuid: str --- The UUID of the Container to return. 1359 1360 Optional parameters: 1361 1362 * select: Optional[List] --- An array of names of attributes to return in the response. 1363 """ 1364 1365 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[ContainerList]': 1366 """Retrieve a ContainerList. 1367 1368 This method returns a single page of `Container` objects that match your search 1369 criteria. If you just want to iterate all objects that match your search 1370 criteria, consider using `arvados.util.keyset_list_all`. 1371 1372 Optional parameters: 1373 1374 * bypass_federation: bool --- If true, do not return results from other clusters in the 1375 federation, only the cluster that received the request. 1376 You must be an administrator to use this flag. Default `False`. 1377 1378 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1379 1380 * count: str --- A string to determine result counting behavior. Supported values are: 1381 1382 * `"exact"`: The response will include an `items_available` field that 1383 counts the number of objects that matched this search criteria, 1384 including ones not included in `items`. 1385 1386 * `"none"`: The response will not include an `items_avaliable` 1387 field. This improves performance by returning a result as soon as enough 1388 `items` have been loaded for this result. 1389 1390 Default `'exact'`. 1391 1392 * distinct: bool --- If this is true, and multiple objects have the same values 1393 for the attributes that you specify in the `select` parameter, then each unique 1394 set of values will only be returned once in the result set. Default `False`. 1395 1396 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1397 Refer to the [filters reference][] for more information about how to write filters. 1398 1399 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1400 1401 * limit: int --- The maximum number of objects to return in the result. 1402 Note that the API may return fewer results than this if your request hits other 1403 limits set by the administrator. Default `100`. 1404 1405 * offset: int --- Return matching objects starting from this index. 1406 Note that result indexes may change if objects are modified in between a series 1407 of list calls. Default `0`. 1408 1409 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1410 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1411 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1412 1413 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1414 1415 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1416 The keys of this object are attribute names. 1417 Each value is either a single matching value or an array of matching values for that attribute. 1418 The `filters` parameter is more flexible and preferred. 1419 """ 1420 1421 def lock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1422 """Lock a container (for a dispatcher to begin running it). 1423 1424 Required parameters: 1425 1426 * uuid: str --- The UUID of the Container to update. 1427 """ 1428 1429 def secret_mounts(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1430 """Return secret mount information for the container associated with the API token authorizing this request. 1431 1432 Required parameters: 1433 1434 * uuid: str --- The UUID of the Container to query. 1435 """ 1436 1437 def unlock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1438 """Unlock a container (for a dispatcher to stop running it). 1439 1440 Required parameters: 1441 1442 * uuid: str --- The UUID of the Container to update. 1443 """ 1444 1445 def update(self, *, body: "Dict[Literal['container'], Container]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1446 """Update attributes of an existing Container. 1447 1448 Required parameters: 1449 1450 * body: Dict[Literal['container'], Container] --- A dictionary with a single item `'container'`. 1451 Its value is a `Container` dictionary defining the attributes to set. 1452 1453 * uuid: str --- The UUID of the Container to update. 1454 1455 Optional parameters: 1456 1457 * select: Optional[List] --- An array of names of attributes to return in the response. 1458 """ 1459 1460 def update_priority(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1461 """Recalculate and return the priority of a given container. 1462 1463 Required parameters: 1464 1465 * uuid: str --- The UUID of the Container to update. 1466 """ 1467 1468 1469class Group(TypedDict, total=False): 1470 """Arvados group 1471 1472 Groups provide a way to organize users or data together, depending on their 1473 `group_class`. 1474 1475 This is the dictionary object that represents a single Group in Arvados 1476 and is returned by most `Groups` methods. 1477 The keys of the dictionary are documented below, along with their types. 1478 Not every key may appear in every dictionary returned by an API call. 1479 When a method doesn't return all the data, you can use its `select` parameter 1480 to list the specific keys you need. Refer to the API documentation for details. 1481 """ 1482 etag: 'str' 1483 """Object cache version.""" 1484 uuid: 'str' 1485 """This group's Arvados UUID, like `zzzzz-j7d0g-12345abcde67890`.""" 1486 owner_uuid: 'str' 1487 """The UUID of the user or group that owns this group.""" 1488 created_at: 'str' 1489 """The time this group was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1490 modified_by_user_uuid: 'str' 1491 """The UUID of the user that last updated this group.""" 1492 modified_at: 'str' 1493 """The time this group was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1494 name: 'str' 1495 """The name of this group assigned by a user.""" 1496 description: 'str' 1497 """A longer HTML description of this group assigned by a user. 1498 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 1499 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 1500 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 1501 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 1502 """ 1503 group_class: 'str' 1504 """A string representing which type of group this is. One of: 1505 1506 * `"filter"` --- A virtual project whose contents are selected dynamically by filters. 1507 * `"project"` --- An Arvados project that can contain collections, 1508 container records, workflows, and subprojects. 1509 * `"role"` --- A group of users that can be granted permissions in Arvados. 1510 """ 1511 trash_at: 'str' 1512 """The time this group will be trashed. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1513 is_trashed: 'bool' 1514 """A boolean flag to indicate whether or not this group is trashed.""" 1515 delete_at: 'str' 1516 """The time this group will be permanently deleted. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1517 properties: 'Dict[str, Any]' 1518 """A hash of arbitrary metadata for this group. 1519 Some keys may be reserved by Arvados or defined by a configured vocabulary. 1520 Refer to the [metadata properties reference][] for details. 1521 1522 [metadata properties reference]: https://doc.arvados.org/api/properties.html 1523 """ 1524 frozen_by_uuid: 'str' 1525 """The UUID of the user that has frozen this group, if any. Frozen projects 1526 cannot have their contents or metadata changed, even by admins. 1527 """ 1528 1529 1530class GroupList(TypedDict, total=False): 1531 """A list of Group objects. 1532 1533 This is the dictionary object returned when you call `Groups.list`. 1534 If you just want to iterate all objects that match your search criteria, 1535 consider using `arvados.util.keyset_list_all`. 1536 If you work with this raw object, the keys of the dictionary are documented 1537 below, along with their types. The `items` key maps to a list of matching 1538 `Group` objects. 1539 """ 1540 kind: 'str' = 'arvados#groupList' 1541 """Object type. Always arvados#groupList.""" 1542 etag: 'str' 1543 """List cache version.""" 1544 items: 'List[Group]' 1545 """An array of matching Group objects.""" 1546 1547 1548class Groups: 1549 """Methods to query and manipulate Arvados groups""" 1550 1551 def contents(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, exclude_home_project: 'bool' = False, filters: 'Optional[List]' = None, include: 'Optional[List]' = None, include_old_versions: 'bool' = False, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, recursive: 'bool' = False, select: 'Optional[List]' = None, uuid: 'str' = '', where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[Group]': 1552 """List objects that belong to a group. 1553 1554 Optional parameters: 1555 1556 * bypass_federation: bool --- If true, do not return results from other clusters in the 1557 federation, only the cluster that received the request. 1558 You must be an administrator to use this flag. Default `False`. 1559 1560 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1561 1562 * count: str --- A string to determine result counting behavior. Supported values are: 1563 1564 * `"exact"`: The response will include an `items_available` field that 1565 counts the number of objects that matched this search criteria, 1566 including ones not included in `items`. 1567 1568 * `"none"`: The response will not include an `items_avaliable` 1569 field. This improves performance by returning a result as soon as enough 1570 `items` have been loaded for this result. 1571 1572 Default `'exact'`. 1573 1574 * distinct: bool --- If this is true, and multiple objects have the same values 1575 for the attributes that you specify in the `select` parameter, then each unique 1576 set of values will only be returned once in the result set. Default `False`. 1577 1578 * exclude_home_project: bool --- If true, exclude contents of the user's home project from the listing. 1579 Calling this method with this flag set is how clients enumerate objects shared 1580 with the current user. Default `False`. 1581 1582 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1583 Refer to the [filters reference][] for more information about how to write filters. 1584 1585 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1586 1587 * include: Optional[List] --- An array of referenced objects to include in the `included` field of the response. Supported values in the array are: 1588 1589 * `"container_uuid"` 1590 * `"owner_uuid"` 1591 1592 1593 1594 * include_old_versions: bool --- If true, include past versions of collections in the listing. Default `False`. 1595 1596 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1597 1598 * limit: int --- The maximum number of objects to return in the result. 1599 Note that the API may return fewer results than this if your request hits other 1600 limits set by the administrator. Default `100`. 1601 1602 * offset: int --- Return matching objects starting from this index. 1603 Note that result indexes may change if objects are modified in between a series 1604 of list calls. Default `0`. 1605 1606 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1607 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1608 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1609 1610 * recursive: bool --- If true, include contents from child groups recursively. Default `False`. 1611 1612 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1613 1614 * uuid: str --- If given, limit the listing to objects owned by the 1615 user or group with this UUID. Default `''`. 1616 1617 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1618 The keys of this object are attribute names. 1619 Each value is either a single matching value or an array of matching values for that attribute. 1620 The `filters` parameter is more flexible and preferred. 1621 """ 1622 1623 def create(self, *, body: "Dict[Literal['group'], Group]", async_: 'bool' = False, cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1624 """Create a new Group. 1625 1626 Required parameters: 1627 1628 * body: Dict[Literal['group'], Group] --- A dictionary with a single item `'group'`. 1629 Its value is a `Group` dictionary defining the attributes to set. 1630 1631 Optional parameters: 1632 1633 * async: bool --- If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default `False`. 1634 1635 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1636 1637 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 1638 1639 * select: Optional[List] --- An array of names of attributes to return in the response. 1640 """ 1641 1642 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1643 """Delete an existing Group. 1644 1645 Required parameters: 1646 1647 * uuid: str --- The UUID of the Group to delete. 1648 """ 1649 1650 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1651 """Get a Group record by UUID. 1652 1653 Required parameters: 1654 1655 * uuid: str --- The UUID of the Group to return. 1656 1657 Optional parameters: 1658 1659 * include_trash: bool --- Return group/project even if its `is_trashed` attribute is true. Default `False`. 1660 1661 * select: Optional[List] --- An array of names of attributes to return in the response. 1662 """ 1663 1664 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[GroupList]': 1665 """Retrieve a GroupList. 1666 1667 This method returns a single page of `Group` objects that match your search 1668 criteria. If you just want to iterate all objects that match your search 1669 criteria, consider using `arvados.util.keyset_list_all`. 1670 1671 Optional parameters: 1672 1673 * bypass_federation: bool --- If true, do not return results from other clusters in the 1674 federation, only the cluster that received the request. 1675 You must be an administrator to use this flag. Default `False`. 1676 1677 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1678 1679 * count: str --- A string to determine result counting behavior. Supported values are: 1680 1681 * `"exact"`: The response will include an `items_available` field that 1682 counts the number of objects that matched this search criteria, 1683 including ones not included in `items`. 1684 1685 * `"none"`: The response will not include an `items_avaliable` 1686 field. This improves performance by returning a result as soon as enough 1687 `items` have been loaded for this result. 1688 1689 Default `'exact'`. 1690 1691 * distinct: bool --- If this is true, and multiple objects have the same values 1692 for the attributes that you specify in the `select` parameter, then each unique 1693 set of values will only be returned once in the result set. Default `False`. 1694 1695 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1696 Refer to the [filters reference][] for more information about how to write filters. 1697 1698 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1699 1700 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1701 1702 * limit: int --- The maximum number of objects to return in the result. 1703 Note that the API may return fewer results than this if your request hits other 1704 limits set by the administrator. Default `100`. 1705 1706 * offset: int --- Return matching objects starting from this index. 1707 Note that result indexes may change if objects are modified in between a series 1708 of list calls. Default `0`. 1709 1710 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1711 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1712 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1713 1714 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1715 1716 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1717 The keys of this object are attribute names. 1718 Each value is either a single matching value or an array of matching values for that attribute. 1719 The `filters` parameter is more flexible and preferred. 1720 """ 1721 1722 def shared(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, include: 'Optional[str]' = None, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[Group]': 1723 """List groups that the current user can access via permission links. 1724 1725 Optional parameters: 1726 1727 * bypass_federation: bool --- If true, do not return results from other clusters in the 1728 federation, only the cluster that received the request. 1729 You must be an administrator to use this flag. Default `False`. 1730 1731 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1732 1733 * count: str --- A string to determine result counting behavior. Supported values are: 1734 1735 * `"exact"`: The response will include an `items_available` field that 1736 counts the number of objects that matched this search criteria, 1737 including ones not included in `items`. 1738 1739 * `"none"`: The response will not include an `items_avaliable` 1740 field. This improves performance by returning a result as soon as enough 1741 `items` have been loaded for this result. 1742 1743 Default `'exact'`. 1744 1745 * distinct: bool --- If this is true, and multiple objects have the same values 1746 for the attributes that you specify in the `select` parameter, then each unique 1747 set of values will only be returned once in the result set. Default `False`. 1748 1749 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1750 Refer to the [filters reference][] for more information about how to write filters. 1751 1752 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1753 1754 * include: Optional[str] --- A string naming referenced objects to include in the `included` field of the response. Supported values are: 1755 1756 * `"owner_uuid"` 1757 1758 1759 1760 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1761 1762 * limit: int --- The maximum number of objects to return in the result. 1763 Note that the API may return fewer results than this if your request hits other 1764 limits set by the administrator. Default `100`. 1765 1766 * offset: int --- Return matching objects starting from this index. 1767 Note that result indexes may change if objects are modified in between a series 1768 of list calls. Default `0`. 1769 1770 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1771 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1772 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1773 1774 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1775 1776 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1777 The keys of this object are attribute names. 1778 Each value is either a single matching value or an array of matching values for that attribute. 1779 The `filters` parameter is more flexible and preferred. 1780 """ 1781 1782 def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1783 """Trash a group. 1784 1785 Required parameters: 1786 1787 * uuid: str --- The UUID of the Group to update. 1788 """ 1789 1790 def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1791 """Untrash a group. 1792 1793 Required parameters: 1794 1795 * uuid: str --- The UUID of the Group to update. 1796 """ 1797 1798 def update(self, *, body: "Dict[Literal['group'], Group]", uuid: 'str', async_: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1799 """Update attributes of an existing Group. 1800 1801 Required parameters: 1802 1803 * body: Dict[Literal['group'], Group] --- A dictionary with a single item `'group'`. 1804 Its value is a `Group` dictionary defining the attributes to set. 1805 1806 * uuid: str --- The UUID of the Group to update. 1807 1808 Optional parameters: 1809 1810 * async: bool --- If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default `False`. 1811 1812 * select: Optional[List] --- An array of names of attributes to return in the response. 1813 """ 1814 1815 1816class KeepService(TypedDict, total=False): 1817 """Arvados Keep service 1818 1819 This resource stores information about a single Keep service in this Arvados 1820 cluster that clients can contact to retrieve and store data. 1821 1822 This is the dictionary object that represents a single KeepService in Arvados 1823 and is returned by most `KeepServices` methods. 1824 The keys of the dictionary are documented below, along with their types. 1825 Not every key may appear in every dictionary returned by an API call. 1826 When a method doesn't return all the data, you can use its `select` parameter 1827 to list the specific keys you need. Refer to the API documentation for details. 1828 """ 1829 etag: 'str' 1830 """Object cache version.""" 1831 uuid: 'str' 1832 """This Keep service's Arvados UUID, like `zzzzz-bi6l4-12345abcde67890`.""" 1833 owner_uuid: 'str' 1834 """The UUID of the user or group that owns this Keep service.""" 1835 modified_by_user_uuid: 'str' 1836 """The UUID of the user that last updated this Keep service.""" 1837 modified_at: 'str' 1838 """The time this Keep service was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1839 service_host: 'str' 1840 """The DNS hostname of this Keep service.""" 1841 service_port: 'int' 1842 """The TCP port where this Keep service listens.""" 1843 service_ssl_flag: 'bool' 1844 """A boolean flag that indicates whether or not this Keep service uses TLS/SSL.""" 1845 service_type: 'str' 1846 """A string that describes which type of Keep service this is. One of: 1847 1848 * `"disk"` --- A service that stores blocks on a local filesystem. 1849 * `"blob"` --- A service that stores blocks in a cloud object store. 1850 * `"proxy"` --- A keepproxy service. 1851 """ 1852 created_at: 'str' 1853 """The time this Keep service was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1854 read_only: 'bool' 1855 """A boolean flag. If set, this Keep service does not accept requests to write data 1856 blocks; it only serves blocks it already has. 1857 """ 1858 1859 1860class KeepServiceList(TypedDict, total=False): 1861 """A list of KeepService objects. 1862 1863 This is the dictionary object returned when you call `KeepServices.list`. 1864 If you just want to iterate all objects that match your search criteria, 1865 consider using `arvados.util.keyset_list_all`. 1866 If you work with this raw object, the keys of the dictionary are documented 1867 below, along with their types. The `items` key maps to a list of matching 1868 `KeepService` objects. 1869 """ 1870 kind: 'str' = 'arvados#keepServiceList' 1871 """Object type. Always arvados#keepServiceList.""" 1872 etag: 'str' 1873 """List cache version.""" 1874 items: 'List[KeepService]' 1875 """An array of matching KeepService objects.""" 1876 1877 1878class KeepServices: 1879 """Methods to query and manipulate Arvados keep services""" 1880 1881 def accessible(self) -> 'ArvadosAPIRequest[KeepService]': 1882 """List Keep services that the current client can access.""" 1883 1884 def create(self, *, body: "Dict[Literal['keep_service'], KeepService]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1885 """Create a new KeepService. 1886 1887 Required parameters: 1888 1889 * body: Dict[Literal['keep_service'], KeepService] --- A dictionary with a single item `'keep_service'`. 1890 Its value is a `KeepService` dictionary defining the attributes to set. 1891 1892 Optional parameters: 1893 1894 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1895 1896 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 1897 1898 * select: Optional[List] --- An array of names of attributes to return in the response. 1899 """ 1900 1901 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[KeepService]': 1902 """Delete an existing KeepService. 1903 1904 Required parameters: 1905 1906 * uuid: str --- The UUID of the KeepService to delete. 1907 """ 1908 1909 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1910 """Get a KeepService record by UUID. 1911 1912 Required parameters: 1913 1914 * uuid: str --- The UUID of the KeepService to return. 1915 1916 Optional parameters: 1917 1918 * select: Optional[List] --- An array of names of attributes to return in the response. 1919 """ 1920 1921 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[KeepServiceList]': 1922 """Retrieve a KeepServiceList. 1923 1924 This method returns a single page of `KeepService` objects that match your search 1925 criteria. If you just want to iterate all objects that match your search 1926 criteria, consider using `arvados.util.keyset_list_all`. 1927 1928 Optional parameters: 1929 1930 * bypass_federation: bool --- If true, do not return results from other clusters in the 1931 federation, only the cluster that received the request. 1932 You must be an administrator to use this flag. Default `False`. 1933 1934 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1935 1936 * count: str --- A string to determine result counting behavior. Supported values are: 1937 1938 * `"exact"`: The response will include an `items_available` field that 1939 counts the number of objects that matched this search criteria, 1940 including ones not included in `items`. 1941 1942 * `"none"`: The response will not include an `items_avaliable` 1943 field. This improves performance by returning a result as soon as enough 1944 `items` have been loaded for this result. 1945 1946 Default `'exact'`. 1947 1948 * distinct: bool --- If this is true, and multiple objects have the same values 1949 for the attributes that you specify in the `select` parameter, then each unique 1950 set of values will only be returned once in the result set. Default `False`. 1951 1952 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1953 Refer to the [filters reference][] for more information about how to write filters. 1954 1955 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1956 1957 * limit: int --- The maximum number of objects to return in the result. 1958 Note that the API may return fewer results than this if your request hits other 1959 limits set by the administrator. Default `100`. 1960 1961 * offset: int --- Return matching objects starting from this index. 1962 Note that result indexes may change if objects are modified in between a series 1963 of list calls. Default `0`. 1964 1965 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1966 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1967 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1968 1969 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1970 1971 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1972 The keys of this object are attribute names. 1973 Each value is either a single matching value or an array of matching values for that attribute. 1974 The `filters` parameter is more flexible and preferred. 1975 """ 1976 1977 def update(self, *, body: "Dict[Literal['keep_service'], KeepService]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1978 """Update attributes of an existing KeepService. 1979 1980 Required parameters: 1981 1982 * body: Dict[Literal['keep_service'], KeepService] --- A dictionary with a single item `'keep_service'`. 1983 Its value is a `KeepService` dictionary defining the attributes to set. 1984 1985 * uuid: str --- The UUID of the KeepService to update. 1986 1987 Optional parameters: 1988 1989 * select: Optional[List] --- An array of names of attributes to return in the response. 1990 """ 1991 1992 1993class Link(TypedDict, total=False): 1994 """Arvados object link 1995 1996 A link provides a way to define relationships between Arvados objects, 1997 depending on their `link_class`. 1998 1999 This is the dictionary object that represents a single Link in Arvados 2000 and is returned by most `Links` methods. 2001 The keys of the dictionary are documented below, along with their types. 2002 Not every key may appear in every dictionary returned by an API call. 2003 When a method doesn't return all the data, you can use its `select` parameter 2004 to list the specific keys you need. Refer to the API documentation for details. 2005 """ 2006 etag: 'str' 2007 """Object cache version.""" 2008 uuid: 'str' 2009 """This link's Arvados UUID, like `zzzzz-o0j2j-12345abcde67890`.""" 2010 owner_uuid: 'str' 2011 """The UUID of the user or group that owns this link.""" 2012 created_at: 'str' 2013 """The time this link was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2014 modified_by_user_uuid: 'str' 2015 """The UUID of the user that last updated this link.""" 2016 modified_at: 'str' 2017 """The time this link was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2018 tail_uuid: 'str' 2019 """The UUID of the Arvados object that is the target of this relationship.""" 2020 link_class: 'str' 2021 """A string that defines which kind of link this is. One of: 2022 2023 * `"permission"` --- This link grants a permission to the user or group 2024 referenced by `head_uuid` to the object referenced by `tail_uuid`. The 2025 access level is set by `name`. 2026 * `"star"` --- This link represents a "favorite." The user referenced 2027 by `head_uuid` wants quick access to the object referenced by `tail_uuid`. 2028 * `"tag"` --- This link represents an unstructured metadata tag. The object 2029 referenced by `tail_uuid` has the tag defined by `name`. 2030 """ 2031 name: 'str' 2032 """The primary value of this link. For `"permission"` links, this is one of 2033 `"can_read"`, `"can_write"`, or `"can_manage"`. 2034 """ 2035 head_uuid: 'str' 2036 """The UUID of the Arvados object that is the originator or actor in this 2037 relationship. May be null. 2038 """ 2039 properties: 'Dict[str, Any]' 2040 """A hash of arbitrary metadata for this link. 2041 Some keys may be reserved by Arvados or defined by a configured vocabulary. 2042 Refer to the [metadata properties reference][] for details. 2043 2044 [metadata properties reference]: https://doc.arvados.org/api/properties.html 2045 """ 2046 2047 2048class LinkList(TypedDict, total=False): 2049 """A list of Link objects. 2050 2051 This is the dictionary object returned when you call `Links.list`. 2052 If you just want to iterate all objects that match your search criteria, 2053 consider using `arvados.util.keyset_list_all`. 2054 If you work with this raw object, the keys of the dictionary are documented 2055 below, along with their types. The `items` key maps to a list of matching 2056 `Link` objects. 2057 """ 2058 kind: 'str' = 'arvados#linkList' 2059 """Object type. Always arvados#linkList.""" 2060 etag: 'str' 2061 """List cache version.""" 2062 items: 'List[Link]' 2063 """An array of matching Link objects.""" 2064 2065 2066class Links: 2067 """Methods to query and manipulate Arvados links""" 2068 2069 def create(self, *, body: "Dict[Literal['link'], Link]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2070 """Create a new Link. 2071 2072 Required parameters: 2073 2074 * body: Dict[Literal['link'], Link] --- A dictionary with a single item `'link'`. 2075 Its value is a `Link` dictionary defining the attributes to set. 2076 2077 Optional parameters: 2078 2079 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2080 2081 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2082 2083 * select: Optional[List] --- An array of names of attributes to return in the response. 2084 """ 2085 2086 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]': 2087 """Delete an existing Link. 2088 2089 Required parameters: 2090 2091 * uuid: str --- The UUID of the Link to delete. 2092 """ 2093 2094 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2095 """Get a Link record by UUID. 2096 2097 Required parameters: 2098 2099 * uuid: str --- The UUID of the Link to return. 2100 2101 Optional parameters: 2102 2103 * select: Optional[List] --- An array of names of attributes to return in the response. 2104 """ 2105 2106 def get_permissions(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]': 2107 """List permissions granted on an Arvados object. 2108 2109 Required parameters: 2110 2111 * uuid: str --- The UUID of the Link to query. 2112 """ 2113 2114 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[LinkList]': 2115 """Retrieve a LinkList. 2116 2117 This method returns a single page of `Link` objects that match your search 2118 criteria. If you just want to iterate all objects that match your search 2119 criteria, consider using `arvados.util.keyset_list_all`. 2120 2121 Optional parameters: 2122 2123 * bypass_federation: bool --- If true, do not return results from other clusters in the 2124 federation, only the cluster that received the request. 2125 You must be an administrator to use this flag. Default `False`. 2126 2127 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2128 2129 * count: str --- A string to determine result counting behavior. Supported values are: 2130 2131 * `"exact"`: The response will include an `items_available` field that 2132 counts the number of objects that matched this search criteria, 2133 including ones not included in `items`. 2134 2135 * `"none"`: The response will not include an `items_avaliable` 2136 field. This improves performance by returning a result as soon as enough 2137 `items` have been loaded for this result. 2138 2139 Default `'exact'`. 2140 2141 * distinct: bool --- If this is true, and multiple objects have the same values 2142 for the attributes that you specify in the `select` parameter, then each unique 2143 set of values will only be returned once in the result set. Default `False`. 2144 2145 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2146 Refer to the [filters reference][] for more information about how to write filters. 2147 2148 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2149 2150 * limit: int --- The maximum number of objects to return in the result. 2151 Note that the API may return fewer results than this if your request hits other 2152 limits set by the administrator. Default `100`. 2153 2154 * offset: int --- Return matching objects starting from this index. 2155 Note that result indexes may change if objects are modified in between a series 2156 of list calls. Default `0`. 2157 2158 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2159 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2160 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2161 2162 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2163 2164 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2165 The keys of this object are attribute names. 2166 Each value is either a single matching value or an array of matching values for that attribute. 2167 The `filters` parameter is more flexible and preferred. 2168 """ 2169 2170 def update(self, *, body: "Dict[Literal['link'], Link]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2171 """Update attributes of an existing Link. 2172 2173 Required parameters: 2174 2175 * body: Dict[Literal['link'], Link] --- A dictionary with a single item `'link'`. 2176 Its value is a `Link` dictionary defining the attributes to set. 2177 2178 * uuid: str --- The UUID of the Link to update. 2179 2180 Optional parameters: 2181 2182 * select: Optional[List] --- An array of names of attributes to return in the response. 2183 """ 2184 2185 2186class Log(TypedDict, total=False): 2187 """Arvados log record 2188 2189 This resource represents a single log record about an event in this Arvados 2190 cluster. Some individual Arvados services create log records. Users can also 2191 create custom logs. 2192 2193 This is the dictionary object that represents a single Log in Arvados 2194 and is returned by most `Logs` methods. 2195 The keys of the dictionary are documented below, along with their types. 2196 Not every key may appear in every dictionary returned by an API call. 2197 When a method doesn't return all the data, you can use its `select` parameter 2198 to list the specific keys you need. Refer to the API documentation for details. 2199 """ 2200 etag: 'str' 2201 """Object cache version.""" 2202 id: 'int' 2203 """The serial number of this log. You can use this in filters to query logs 2204 that were created before/after another. 2205 """ 2206 uuid: 'str' 2207 """This log's Arvados UUID, like `zzzzz-57u5n-12345abcde67890`.""" 2208 owner_uuid: 'str' 2209 """The UUID of the user or group that owns this log.""" 2210 modified_by_user_uuid: 'str' 2211 """The UUID of the user that last updated this log.""" 2212 object_uuid: 'str' 2213 """The UUID of the Arvados object that this log pertains to, such as a user 2214 or container. 2215 """ 2216 event_at: 'str' 2217 """The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2218 event_type: 'str' 2219 """An arbitrary short string that classifies what type of log this is.""" 2220 summary: 'str' 2221 """A text string that describes the logged event. This is the primary 2222 attribute for simple logs. 2223 """ 2224 properties: 'Dict[str, Any]' 2225 """A hash of arbitrary metadata for this log. 2226 Some keys may be reserved by Arvados or defined by a configured vocabulary. 2227 Refer to the [metadata properties reference][] for details. 2228 2229 [metadata properties reference]: https://doc.arvados.org/api/properties.html 2230 """ 2231 created_at: 'str' 2232 """The time this log was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2233 modified_at: 'str' 2234 """The time this log was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2235 object_owner_uuid: 'str' 2236 """The `owner_uuid` of the object referenced by `object_uuid` at the time 2237 this log was created. 2238 """ 2239 2240 2241class LogList(TypedDict, total=False): 2242 """A list of Log objects. 2243 2244 This is the dictionary object returned when you call `Logs.list`. 2245 If you just want to iterate all objects that match your search criteria, 2246 consider using `arvados.util.keyset_list_all`. 2247 If you work with this raw object, the keys of the dictionary are documented 2248 below, along with their types. The `items` key maps to a list of matching 2249 `Log` objects. 2250 """ 2251 kind: 'str' = 'arvados#logList' 2252 """Object type. Always arvados#logList.""" 2253 etag: 'str' 2254 """List cache version.""" 2255 items: 'List[Log]' 2256 """An array of matching Log objects.""" 2257 2258 2259class Logs: 2260 """Methods to query and manipulate Arvados logs""" 2261 2262 def create(self, *, body: "Dict[Literal['log'], Log]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2263 """Create a new Log. 2264 2265 Required parameters: 2266 2267 * body: Dict[Literal['log'], Log] --- A dictionary with a single item `'log'`. 2268 Its value is a `Log` dictionary defining the attributes to set. 2269 2270 Optional parameters: 2271 2272 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2273 2274 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2275 2276 * select: Optional[List] --- An array of names of attributes to return in the response. 2277 """ 2278 2279 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Log]': 2280 """Delete an existing Log. 2281 2282 Required parameters: 2283 2284 * uuid: str --- The UUID of the Log to delete. 2285 """ 2286 2287 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2288 """Get a Log record by UUID. 2289 2290 Required parameters: 2291 2292 * uuid: str --- The UUID of the Log to return. 2293 2294 Optional parameters: 2295 2296 * select: Optional[List] --- An array of names of attributes to return in the response. 2297 """ 2298 2299 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[LogList]': 2300 """Retrieve a LogList. 2301 2302 This method returns a single page of `Log` objects that match your search 2303 criteria. If you just want to iterate all objects that match your search 2304 criteria, consider using `arvados.util.keyset_list_all`. 2305 2306 Optional parameters: 2307 2308 * bypass_federation: bool --- If true, do not return results from other clusters in the 2309 federation, only the cluster that received the request. 2310 You must be an administrator to use this flag. Default `False`. 2311 2312 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2313 2314 * count: str --- A string to determine result counting behavior. Supported values are: 2315 2316 * `"exact"`: The response will include an `items_available` field that 2317 counts the number of objects that matched this search criteria, 2318 including ones not included in `items`. 2319 2320 * `"none"`: The response will not include an `items_avaliable` 2321 field. This improves performance by returning a result as soon as enough 2322 `items` have been loaded for this result. 2323 2324 Default `'exact'`. 2325 2326 * distinct: bool --- If this is true, and multiple objects have the same values 2327 for the attributes that you specify in the `select` parameter, then each unique 2328 set of values will only be returned once in the result set. Default `False`. 2329 2330 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2331 Refer to the [filters reference][] for more information about how to write filters. 2332 2333 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2334 2335 * limit: int --- The maximum number of objects to return in the result. 2336 Note that the API may return fewer results than this if your request hits other 2337 limits set by the administrator. Default `100`. 2338 2339 * offset: int --- Return matching objects starting from this index. 2340 Note that result indexes may change if objects are modified in between a series 2341 of list calls. Default `0`. 2342 2343 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2344 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2345 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2346 2347 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2348 2349 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2350 The keys of this object are attribute names. 2351 Each value is either a single matching value or an array of matching values for that attribute. 2352 The `filters` parameter is more flexible and preferred. 2353 """ 2354 2355 def update(self, *, body: "Dict[Literal['log'], Log]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2356 """Update attributes of an existing Log. 2357 2358 Required parameters: 2359 2360 * body: Dict[Literal['log'], Log] --- A dictionary with a single item `'log'`. 2361 Its value is a `Log` dictionary defining the attributes to set. 2362 2363 * uuid: str --- The UUID of the Log to update. 2364 2365 Optional parameters: 2366 2367 * select: Optional[List] --- An array of names of attributes to return in the response. 2368 """ 2369 2370 2371class Sys: 2372 """Methods to query and manipulate Arvados sys""" 2373 2374 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 2375 """Run scheduled data trash and sweep operations across this cluster's Keep services.""" 2376 2377 2378class UserAgreement(TypedDict, total=False): 2379 """Arvados user agreement 2380 2381 A user agreement is a collection with terms that users must agree to before 2382 they can use this Arvados cluster. 2383 2384 This is the dictionary object that represents a single UserAgreement in Arvados 2385 and is returned by most `UserAgreements` methods. 2386 The keys of the dictionary are documented below, along with their types. 2387 Not every key may appear in every dictionary returned by an API call. 2388 When a method doesn't return all the data, you can use its `select` parameter 2389 to list the specific keys you need. Refer to the API documentation for details. 2390 """ 2391 etag: 'str' 2392 """Object cache version.""" 2393 owner_uuid: 'str' 2394 """The UUID of the user or group that owns this user agreement.""" 2395 created_at: 'str' 2396 """The time this user agreement was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2397 modified_by_user_uuid: 'str' 2398 """The UUID of the user that last updated this user agreement.""" 2399 modified_at: 'str' 2400 """The time this user agreement was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2401 portable_data_hash: 'str' 2402 """The portable data hash of this user agreement. This string provides a unique 2403 and stable reference to these contents. 2404 """ 2405 replication_desired: 'int' 2406 """The number of copies that should be made for data in this user agreement.""" 2407 replication_confirmed_at: 'str' 2408 """The last time the cluster confirmed that it met `replication_confirmed` 2409 for this user agreement. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`. 2410 """ 2411 replication_confirmed: 'int' 2412 """The number of copies of data in this user agreement that the cluster has confirmed 2413 exist in storage. 2414 """ 2415 uuid: 'str' 2416 """This user agreement's Arvados UUID, like `zzzzz-gv0sa-12345abcde67890`.""" 2417 manifest_text: 'str' 2418 """The manifest text that describes how files are constructed from data blocks 2419 in this user agreement. Refer to the [manifest format][] reference for details. 2420 2421 [manifest format]: https://doc.arvados.org/architecture/manifest-format.html 2422 """ 2423 name: 'str' 2424 """The name of this user agreement assigned by a user.""" 2425 description: 'str' 2426 """A longer HTML description of this user agreement assigned by a user. 2427 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 2428 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 2429 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 2430 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 2431 """ 2432 properties: 'Dict[str, Any]' 2433 """A hash of arbitrary metadata for this user agreement. 2434 Some keys may be reserved by Arvados or defined by a configured vocabulary. 2435 Refer to the [metadata properties reference][] for details. 2436 2437 [metadata properties reference]: https://doc.arvados.org/api/properties.html 2438 """ 2439 delete_at: 'str' 2440 """The time this user agreement will be permanently deleted. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2441 trash_at: 'str' 2442 """The time this user agreement will be trashed. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2443 is_trashed: 'bool' 2444 """A boolean flag to indicate whether or not this user agreement is trashed.""" 2445 storage_classes_desired: 'List' 2446 """An array of strings identifying the storage class(es) that should be used 2447 for data in this user agreement. Storage classes are configured by the cluster administrator. 2448 """ 2449 storage_classes_confirmed: 'List' 2450 """An array of strings identifying the storage class(es) the cluster has 2451 confirmed have a copy of this user agreement's data. 2452 """ 2453 storage_classes_confirmed_at: 'str' 2454 """The last time the cluster confirmed that data was stored on the storage 2455 class(es) in `storage_classes_confirmed`. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`. 2456 """ 2457 current_version_uuid: 'str' 2458 """The UUID of the current version of this user agreement.""" 2459 version: 'int' 2460 """An integer that counts which version of a user agreement this record 2461 represents. Refer to [collection versioning][] for details. This attribute is 2462 read-only. 2463 2464 [collection versioning]: https://doc.arvados.org/user/topics/collection-versioning.html 2465 """ 2466 preserve_version: 'bool' 2467 """A boolean flag to indicate whether this specific version of this user agreement 2468 should be persisted in cluster storage. 2469 """ 2470 file_count: 'int' 2471 """The number of files represented in this user agreement's `manifest_text`. 2472 This attribute is read-only. 2473 """ 2474 file_size_total: 'int' 2475 """The total size in bytes of files represented in this user agreement's `manifest_text`. 2476 This attribute is read-only. 2477 """ 2478 2479 2480class UserAgreementList(TypedDict, total=False): 2481 """A list of UserAgreement objects. 2482 2483 This is the dictionary object returned when you call `UserAgreements.list`. 2484 If you just want to iterate all objects that match your search criteria, 2485 consider using `arvados.util.keyset_list_all`. 2486 If you work with this raw object, the keys of the dictionary are documented 2487 below, along with their types. The `items` key maps to a list of matching 2488 `UserAgreement` objects. 2489 """ 2490 kind: 'str' = 'arvados#userAgreementList' 2491 """Object type. Always arvados#userAgreementList.""" 2492 etag: 'str' 2493 """List cache version.""" 2494 items: 'List[UserAgreement]' 2495 """An array of matching UserAgreement objects.""" 2496 2497 2498class UserAgreements: 2499 """Methods to query and manipulate Arvados user agreements""" 2500 2501 def create(self, *, body: "Dict[Literal['user_agreement'], UserAgreement]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2502 """Create a new UserAgreement. 2503 2504 Required parameters: 2505 2506 * body: Dict[Literal['user_agreement'], UserAgreement] --- A dictionary with a single item `'user_agreement'`. 2507 Its value is a `UserAgreement` dictionary defining the attributes to set. 2508 2509 Optional parameters: 2510 2511 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2512 2513 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2514 2515 * select: Optional[List] --- An array of names of attributes to return in the response. 2516 """ 2517 2518 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[UserAgreement]': 2519 """Delete an existing UserAgreement. 2520 2521 Required parameters: 2522 2523 * uuid: str --- The UUID of the UserAgreement to delete. 2524 """ 2525 2526 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2527 """Get a UserAgreement record by UUID. 2528 2529 Required parameters: 2530 2531 * uuid: str --- The UUID of the UserAgreement to return. 2532 2533 Optional parameters: 2534 2535 * select: Optional[List] --- An array of names of attributes to return in the response. 2536 """ 2537 2538 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[UserAgreementList]': 2539 """Retrieve a UserAgreementList. 2540 2541 This method returns a single page of `UserAgreement` objects that match your search 2542 criteria. If you just want to iterate all objects that match your search 2543 criteria, consider using `arvados.util.keyset_list_all`. 2544 2545 Optional parameters: 2546 2547 * bypass_federation: bool --- If true, do not return results from other clusters in the 2548 federation, only the cluster that received the request. 2549 You must be an administrator to use this flag. Default `False`. 2550 2551 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2552 2553 * count: str --- A string to determine result counting behavior. Supported values are: 2554 2555 * `"exact"`: The response will include an `items_available` field that 2556 counts the number of objects that matched this search criteria, 2557 including ones not included in `items`. 2558 2559 * `"none"`: The response will not include an `items_avaliable` 2560 field. This improves performance by returning a result as soon as enough 2561 `items` have been loaded for this result. 2562 2563 Default `'exact'`. 2564 2565 * distinct: bool --- If this is true, and multiple objects have the same values 2566 for the attributes that you specify in the `select` parameter, then each unique 2567 set of values will only be returned once in the result set. Default `False`. 2568 2569 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2570 Refer to the [filters reference][] for more information about how to write filters. 2571 2572 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2573 2574 * limit: int --- The maximum number of objects to return in the result. 2575 Note that the API may return fewer results than this if your request hits other 2576 limits set by the administrator. Default `100`. 2577 2578 * offset: int --- Return matching objects starting from this index. 2579 Note that result indexes may change if objects are modified in between a series 2580 of list calls. Default `0`. 2581 2582 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2583 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2584 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2585 2586 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2587 2588 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2589 The keys of this object are attribute names. 2590 Each value is either a single matching value or an array of matching values for that attribute. 2591 The `filters` parameter is more flexible and preferred. 2592 """ 2593 2594 def sign(self) -> 'ArvadosAPIRequest[UserAgreement]': 2595 """Create a signature link from the current user for a given user agreement.""" 2596 2597 def signatures(self) -> 'ArvadosAPIRequest[UserAgreement]': 2598 """List all user agreement signature links from a user.""" 2599 2600 def update(self, *, body: "Dict[Literal['user_agreement'], UserAgreement]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2601 """Update attributes of an existing UserAgreement. 2602 2603 Required parameters: 2604 2605 * body: Dict[Literal['user_agreement'], UserAgreement] --- A dictionary with a single item `'user_agreement'`. 2606 Its value is a `UserAgreement` dictionary defining the attributes to set. 2607 2608 * uuid: str --- The UUID of the UserAgreement to update. 2609 2610 Optional parameters: 2611 2612 * select: Optional[List] --- An array of names of attributes to return in the response. 2613 """ 2614 2615 2616class User(TypedDict, total=False): 2617 """Arvados user 2618 2619 A user represents a single individual or role who may be authorized to access 2620 this Arvados cluster. 2621 2622 This is the dictionary object that represents a single User in Arvados 2623 and is returned by most `Users` methods. 2624 The keys of the dictionary are documented below, along with their types. 2625 Not every key may appear in every dictionary returned by an API call. 2626 When a method doesn't return all the data, you can use its `select` parameter 2627 to list the specific keys you need. Refer to the API documentation for details. 2628 """ 2629 etag: 'str' 2630 """Object cache version.""" 2631 uuid: 'str' 2632 """This user's Arvados UUID, like `zzzzz-tpzed-12345abcde67890`.""" 2633 owner_uuid: 'str' 2634 """The UUID of the user or group that owns this user.""" 2635 created_at: 'str' 2636 """The time this user was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2637 modified_by_user_uuid: 'str' 2638 """The UUID of the user that last updated this user.""" 2639 modified_at: 'str' 2640 """The time this user was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2641 email: 'str' 2642 """This user's email address.""" 2643 first_name: 'str' 2644 """This user's first name.""" 2645 last_name: 'str' 2646 """This user's last name.""" 2647 identity_url: 'str' 2648 """A URL that represents this user with the cluster's identity provider.""" 2649 is_admin: 'bool' 2650 """A boolean flag. If set, this user is an administrator of the Arvados 2651 cluster, and automatically passes most permissions checks. 2652 """ 2653 prefs: 'Dict[str, Any]' 2654 """A hash that stores cluster-wide user preferences.""" 2655 is_active: 'bool' 2656 """A boolean flag. If unset, this user is not permitted to make any Arvados 2657 API requests. 2658 """ 2659 username: 'str' 2660 """This user's Unix username on virtual machines.""" 2661 2662 2663class UserList(TypedDict, total=False): 2664 """A list of User objects. 2665 2666 This is the dictionary object returned when you call `Users.list`. 2667 If you just want to iterate all objects that match your search criteria, 2668 consider using `arvados.util.keyset_list_all`. 2669 If you work with this raw object, the keys of the dictionary are documented 2670 below, along with their types. The `items` key maps to a list of matching 2671 `User` objects. 2672 """ 2673 kind: 'str' = 'arvados#userList' 2674 """Object type. Always arvados#userList.""" 2675 etag: 'str' 2676 """List cache version.""" 2677 items: 'List[User]' 2678 """An array of matching User objects.""" 2679 2680 2681class Users: 2682 """Methods to query and manipulate Arvados users""" 2683 2684 def activate(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2685 """Set the `is_active` flag on a user record. 2686 2687 Required parameters: 2688 2689 * uuid: str --- The UUID of the User to update. 2690 """ 2691 2692 def create(self, *, body: "Dict[Literal['user'], User]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2693 """Create a new User. 2694 2695 Required parameters: 2696 2697 * body: Dict[Literal['user'], User] --- A dictionary with a single item `'user'`. 2698 Its value is a `User` dictionary defining the attributes to set. 2699 2700 Optional parameters: 2701 2702 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2703 2704 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2705 2706 * select: Optional[List] --- An array of names of attributes to return in the response. 2707 """ 2708 2709 def current(self) -> 'ArvadosAPIRequest[User]': 2710 """Return the user record associated with the API token authorizing this request.""" 2711 2712 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2713 """Delete an existing User. 2714 2715 Required parameters: 2716 2717 * uuid: str --- The UUID of the User to delete. 2718 """ 2719 2720 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2721 """Get a User record by UUID. 2722 2723 Required parameters: 2724 2725 * uuid: str --- The UUID of the User to return. 2726 2727 Optional parameters: 2728 2729 * select: Optional[List] --- An array of names of attributes to return in the response. 2730 """ 2731 2732 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[UserList]': 2733 """Retrieve a UserList. 2734 2735 This method returns a single page of `User` objects that match your search 2736 criteria. If you just want to iterate all objects that match your search 2737 criteria, consider using `arvados.util.keyset_list_all`. 2738 2739 Optional parameters: 2740 2741 * bypass_federation: bool --- If true, do not return results from other clusters in the 2742 federation, only the cluster that received the request. 2743 You must be an administrator to use this flag. Default `False`. 2744 2745 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2746 2747 * count: str --- A string to determine result counting behavior. Supported values are: 2748 2749 * `"exact"`: The response will include an `items_available` field that 2750 counts the number of objects that matched this search criteria, 2751 including ones not included in `items`. 2752 2753 * `"none"`: The response will not include an `items_avaliable` 2754 field. This improves performance by returning a result as soon as enough 2755 `items` have been loaded for this result. 2756 2757 Default `'exact'`. 2758 2759 * distinct: bool --- If this is true, and multiple objects have the same values 2760 for the attributes that you specify in the `select` parameter, then each unique 2761 set of values will only be returned once in the result set. Default `False`. 2762 2763 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2764 Refer to the [filters reference][] for more information about how to write filters. 2765 2766 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2767 2768 * limit: int --- The maximum number of objects to return in the result. 2769 Note that the API may return fewer results than this if your request hits other 2770 limits set by the administrator. Default `100`. 2771 2772 * offset: int --- Return matching objects starting from this index. 2773 Note that result indexes may change if objects are modified in between a series 2774 of list calls. Default `0`. 2775 2776 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2777 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2778 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2779 2780 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2781 2782 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2783 The keys of this object are attribute names. 2784 Each value is either a single matching value or an array of matching values for that attribute. 2785 The `filters` parameter is more flexible and preferred. 2786 """ 2787 2788 def merge(self, *, new_owner_uuid: 'str', new_user_token: 'Optional[str]' = None, new_user_uuid: 'Optional[str]' = None, old_user_uuid: 'Optional[str]' = None, redirect_to_new_user: 'bool' = False) -> 'ArvadosAPIRequest[User]': 2789 """Transfer ownership of one user's data to another. 2790 2791 Required parameters: 2792 2793 * new_owner_uuid: str --- UUID of the user or group that will take ownership of data owned by the old user. 2794 2795 Optional parameters: 2796 2797 * new_user_token: Optional[str] --- Valid API token for the user receiving ownership. If you use this option, it takes ownership of data owned by the user making the request. 2798 2799 * new_user_uuid: Optional[str] --- UUID of the user receiving ownership. You must be an admin to use this option. 2800 2801 * old_user_uuid: Optional[str] --- UUID of the user whose ownership is being transferred to `new_owner_uuid`. You must be an admin to use this option. 2802 2803 * redirect_to_new_user: bool --- If true, authorization attempts for the old user will be redirected to the new user. Default `False`. 2804 """ 2805 2806 def setup(self, *, repo_name: 'Optional[str]' = None, send_notification_email: 'bool' = False, user: 'Optional[Dict[str, Any]]' = None, uuid: 'Optional[str]' = None, vm_uuid: 'Optional[str]' = None) -> 'ArvadosAPIRequest[User]': 2807 """Convenience method to "fully" set up a user record with a virtual machine login and notification email. 2808 2809 Optional parameters: 2810 2811 * repo_name: Optional[str] --- This parameter is obsolete and ignored. 2812 2813 * send_notification_email: bool --- If true, send an email to the user notifying them they can now access this Arvados cluster. Default `False`. 2814 2815 * user: Optional[Dict[str, Any]] --- Attributes of a new user record to set up. 2816 2817 * uuid: Optional[str] --- UUID of an existing user record to set up. 2818 2819 * vm_uuid: Optional[str] --- If given, setup creates a login link to allow this user to access the Arvados virtual machine with this UUID. 2820 """ 2821 2822 def system(self) -> 'ArvadosAPIRequest[User]': 2823 """Return this cluster's system ("root") user record.""" 2824 2825 def unsetup(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2826 """Unset a user's active flag and delete associated records. 2827 2828 Required parameters: 2829 2830 * uuid: str --- The UUID of the User to update. 2831 """ 2832 2833 def update(self, *, body: "Dict[Literal['user'], User]", uuid: 'str', bypass_federation: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2834 """Update attributes of an existing User. 2835 2836 Required parameters: 2837 2838 * body: Dict[Literal['user'], User] --- A dictionary with a single item `'user'`. 2839 Its value is a `User` dictionary defining the attributes to set. 2840 2841 * uuid: str --- The UUID of the User to update. 2842 2843 Optional parameters: 2844 2845 * bypass_federation: bool --- If true, do not try to update the user on any other clusters in the federation, 2846 only the cluster that received the request. 2847 You must be an administrator to use this flag. Default `False`. 2848 2849 * select: Optional[List] --- An array of names of attributes to return in the response. 2850 """ 2851 2852 2853class VirtualMachine(TypedDict, total=False): 2854 """Arvados virtual machine ("shell node") 2855 2856 This resource stores information about a virtual machine or "shell node" 2857 hosted on this Arvados cluster where users can log in and use preconfigured 2858 Arvados client tools. 2859 2860 This is the dictionary object that represents a single VirtualMachine in Arvados 2861 and is returned by most `VirtualMachines` methods. 2862 The keys of the dictionary are documented below, along with their types. 2863 Not every key may appear in every dictionary returned by an API call. 2864 When a method doesn't return all the data, you can use its `select` parameter 2865 to list the specific keys you need. Refer to the API documentation for details. 2866 """ 2867 etag: 'str' 2868 """Object cache version.""" 2869 uuid: 'str' 2870 """This virtual machine's Arvados UUID, like `zzzzz-2x53u-12345abcde67890`.""" 2871 owner_uuid: 'str' 2872 """The UUID of the user or group that owns this virtual machine.""" 2873 modified_by_user_uuid: 'str' 2874 """The UUID of the user that last updated this virtual machine.""" 2875 modified_at: 'str' 2876 """The time this virtual machine was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2877 hostname: 'str' 2878 """The DNS hostname where users should access this virtual machine.""" 2879 created_at: 'str' 2880 """The time this virtual machine was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2881 2882 2883class VirtualMachineList(TypedDict, total=False): 2884 """A list of VirtualMachine objects. 2885 2886 This is the dictionary object returned when you call `VirtualMachines.list`. 2887 If you just want to iterate all objects that match your search criteria, 2888 consider using `arvados.util.keyset_list_all`. 2889 If you work with this raw object, the keys of the dictionary are documented 2890 below, along with their types. The `items` key maps to a list of matching 2891 `VirtualMachine` objects. 2892 """ 2893 kind: 'str' = 'arvados#virtualMachineList' 2894 """Object type. Always arvados#virtualMachineList.""" 2895 etag: 'str' 2896 """List cache version.""" 2897 items: 'List[VirtualMachine]' 2898 """An array of matching VirtualMachine objects.""" 2899 2900 2901class VirtualMachines: 2902 """Methods to query and manipulate Arvados virtual machines""" 2903 2904 def create(self, *, body: "Dict[Literal['virtual_machine'], VirtualMachine]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 2905 """Create a new VirtualMachine. 2906 2907 Required parameters: 2908 2909 * body: Dict[Literal['virtual_machine'], VirtualMachine] --- A dictionary with a single item `'virtual_machine'`. 2910 Its value is a `VirtualMachine` dictionary defining the attributes to set. 2911 2912 Optional parameters: 2913 2914 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2915 2916 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2917 2918 * select: Optional[List] --- An array of names of attributes to return in the response. 2919 """ 2920 2921 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]': 2922 """Delete an existing VirtualMachine. 2923 2924 Required parameters: 2925 2926 * uuid: str --- The UUID of the VirtualMachine to delete. 2927 """ 2928 2929 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 2930 """Get a VirtualMachine record by UUID. 2931 2932 Required parameters: 2933 2934 * uuid: str --- The UUID of the VirtualMachine to return. 2935 2936 Optional parameters: 2937 2938 * select: Optional[List] --- An array of names of attributes to return in the response. 2939 """ 2940 2941 def get_all_logins(self) -> 'ArvadosAPIRequest[VirtualMachine]': 2942 """List login permission links for all virtual machines.""" 2943 2944 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[VirtualMachineList]': 2945 """Retrieve a VirtualMachineList. 2946 2947 This method returns a single page of `VirtualMachine` objects that match your search 2948 criteria. If you just want to iterate all objects that match your search 2949 criteria, consider using `arvados.util.keyset_list_all`. 2950 2951 Optional parameters: 2952 2953 * bypass_federation: bool --- If true, do not return results from other clusters in the 2954 federation, only the cluster that received the request. 2955 You must be an administrator to use this flag. Default `False`. 2956 2957 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2958 2959 * count: str --- A string to determine result counting behavior. Supported values are: 2960 2961 * `"exact"`: The response will include an `items_available` field that 2962 counts the number of objects that matched this search criteria, 2963 including ones not included in `items`. 2964 2965 * `"none"`: The response will not include an `items_avaliable` 2966 field. This improves performance by returning a result as soon as enough 2967 `items` have been loaded for this result. 2968 2969 Default `'exact'`. 2970 2971 * distinct: bool --- If this is true, and multiple objects have the same values 2972 for the attributes that you specify in the `select` parameter, then each unique 2973 set of values will only be returned once in the result set. Default `False`. 2974 2975 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2976 Refer to the [filters reference][] for more information about how to write filters. 2977 2978 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2979 2980 * limit: int --- The maximum number of objects to return in the result. 2981 Note that the API may return fewer results than this if your request hits other 2982 limits set by the administrator. Default `100`. 2983 2984 * offset: int --- Return matching objects starting from this index. 2985 Note that result indexes may change if objects are modified in between a series 2986 of list calls. Default `0`. 2987 2988 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2989 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2990 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2991 2992 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2993 2994 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2995 The keys of this object are attribute names. 2996 Each value is either a single matching value or an array of matching values for that attribute. 2997 The `filters` parameter is more flexible and preferred. 2998 """ 2999 3000 def logins(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]': 3001 """List login permission links for a given virtual machine. 3002 3003 Required parameters: 3004 3005 * uuid: str --- The UUID of the VirtualMachine to query. 3006 """ 3007 3008 def update(self, *, body: "Dict[Literal['virtual_machine'], VirtualMachine]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 3009 """Update attributes of an existing VirtualMachine. 3010 3011 Required parameters: 3012 3013 * body: Dict[Literal['virtual_machine'], VirtualMachine] --- A dictionary with a single item `'virtual_machine'`. 3014 Its value is a `VirtualMachine` dictionary defining the attributes to set. 3015 3016 * uuid: str --- The UUID of the VirtualMachine to update. 3017 3018 Optional parameters: 3019 3020 * select: Optional[List] --- An array of names of attributes to return in the response. 3021 """ 3022 3023 3024class Vocabularies: 3025 """Methods to query and manipulate Arvados vocabularies""" 3026 3027 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 3028 """Get this cluster's configured vocabulary definition. 3029 3030 Refer to [metadata vocabulary documentation][] for details. 3031 3032 [metadata vocabulary documentation]: https://doc.aravdos.org/admin/metadata-vocabulary.html 3033 """ 3034 3035 3036class Workflow(TypedDict, total=False): 3037 """Arvados workflow 3038 3039 A workflow contains workflow definition source code that Arvados can execute 3040 along with associated metadata for users. 3041 3042 This is the dictionary object that represents a single Workflow in Arvados 3043 and is returned by most `Workflows` methods. 3044 The keys of the dictionary are documented below, along with their types. 3045 Not every key may appear in every dictionary returned by an API call. 3046 When a method doesn't return all the data, you can use its `select` parameter 3047 to list the specific keys you need. Refer to the API documentation for details. 3048 """ 3049 etag: 'str' 3050 """Object cache version.""" 3051 uuid: 'str' 3052 """This workflow's Arvados UUID, like `zzzzz-7fd4e-12345abcde67890`.""" 3053 owner_uuid: 'str' 3054 """The UUID of the user or group that owns this workflow.""" 3055 created_at: 'str' 3056 """The time this workflow was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 3057 modified_at: 'str' 3058 """The time this workflow was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 3059 modified_by_user_uuid: 'str' 3060 """The UUID of the user that last updated this workflow.""" 3061 name: 'str' 3062 """The name of this workflow assigned by a user.""" 3063 description: 'str' 3064 """A longer HTML description of this workflow assigned by a user. 3065 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 3066 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 3067 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 3068 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 3069 """ 3070 definition: 'str' 3071 """A string with the CWL source of this workflow.""" 3072 3073 3074class WorkflowList(TypedDict, total=False): 3075 """A list of Workflow objects. 3076 3077 This is the dictionary object returned when you call `Workflows.list`. 3078 If you just want to iterate all objects that match your search criteria, 3079 consider using `arvados.util.keyset_list_all`. 3080 If you work with this raw object, the keys of the dictionary are documented 3081 below, along with their types. The `items` key maps to a list of matching 3082 `Workflow` objects. 3083 """ 3084 kind: 'str' = 'arvados#workflowList' 3085 """Object type. Always arvados#workflowList.""" 3086 etag: 'str' 3087 """List cache version.""" 3088 items: 'List[Workflow]' 3089 """An array of matching Workflow objects.""" 3090 3091 3092class Workflows: 3093 """Methods to query and manipulate Arvados workflows""" 3094 3095 def create(self, *, body: "Dict[Literal['workflow'], Workflow]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3096 """Create a new Workflow. 3097 3098 Required parameters: 3099 3100 * body: Dict[Literal['workflow'], Workflow] --- A dictionary with a single item `'workflow'`. 3101 Its value is a `Workflow` dictionary defining the attributes to set. 3102 3103 Optional parameters: 3104 3105 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 3106 3107 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 3108 3109 * select: Optional[List] --- An array of names of attributes to return in the response. 3110 """ 3111 3112 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Workflow]': 3113 """Delete an existing Workflow. 3114 3115 Required parameters: 3116 3117 * uuid: str --- The UUID of the Workflow to delete. 3118 """ 3119 3120 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3121 """Get a Workflow record by UUID. 3122 3123 Required parameters: 3124 3125 * uuid: str --- The UUID of the Workflow to return. 3126 3127 Optional parameters: 3128 3129 * select: Optional[List] --- An array of names of attributes to return in the response. 3130 """ 3131 3132 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[WorkflowList]': 3133 """Retrieve a WorkflowList. 3134 3135 This method returns a single page of `Workflow` objects that match your search 3136 criteria. If you just want to iterate all objects that match your search 3137 criteria, consider using `arvados.util.keyset_list_all`. 3138 3139 Optional parameters: 3140 3141 * bypass_federation: bool --- If true, do not return results from other clusters in the 3142 federation, only the cluster that received the request. 3143 You must be an administrator to use this flag. Default `False`. 3144 3145 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 3146 3147 * count: str --- A string to determine result counting behavior. Supported values are: 3148 3149 * `"exact"`: The response will include an `items_available` field that 3150 counts the number of objects that matched this search criteria, 3151 including ones not included in `items`. 3152 3153 * `"none"`: The response will not include an `items_avaliable` 3154 field. This improves performance by returning a result as soon as enough 3155 `items` have been loaded for this result. 3156 3157 Default `'exact'`. 3158 3159 * distinct: bool --- If this is true, and multiple objects have the same values 3160 for the attributes that you specify in the `select` parameter, then each unique 3161 set of values will only be returned once in the result set. Default `False`. 3162 3163 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 3164 Refer to the [filters reference][] for more information about how to write filters. 3165 3166 [filters reference]: https://doc.arvados.org/api/methods.html#filters 3167 3168 * limit: int --- The maximum number of objects to return in the result. 3169 Note that the API may return fewer results than this if your request hits other 3170 limits set by the administrator. Default `100`. 3171 3172 * offset: int --- Return matching objects starting from this index. 3173 Note that result indexes may change if objects are modified in between a series 3174 of list calls. Default `0`. 3175 3176 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 3177 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 3178 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 3179 3180 * select: Optional[List] --- An array of names of attributes to return from each matching object. 3181 3182 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 3183 The keys of this object are attribute names. 3184 Each value is either a single matching value or an array of matching values for that attribute. 3185 The `filters` parameter is more flexible and preferred. 3186 """ 3187 3188 def update(self, *, body: "Dict[Literal['workflow'], Workflow]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3189 """Update attributes of an existing Workflow. 3190 3191 Required parameters: 3192 3193 * body: Dict[Literal['workflow'], Workflow] --- A dictionary with a single item `'workflow'`. 3194 Its value is a `Workflow` dictionary defining the attributes to set. 3195 3196 * uuid: str --- The UUID of the Workflow to update. 3197 3198 Optional parameters: 3199 3200 * select: Optional[List] --- An array of names of attributes to return in the response. 3201 """ 3202 3203 3204class ArvadosAPIClient(googleapiclient.discovery.Resource): 3205 3206 def api_client_authorizations(self) -> 'ApiClientAuthorizations': 3207 """Return an instance of `ApiClientAuthorizations` to call methods via this client""" 3208 3209 def authorized_keys(self) -> 'AuthorizedKeys': 3210 """Return an instance of `AuthorizedKeys` to call methods via this client""" 3211 3212 def collections(self) -> 'Collections': 3213 """Return an instance of `Collections` to call methods via this client""" 3214 3215 def computed_permissions(self) -> 'ComputedPermissions': 3216 """Return an instance of `ComputedPermissions` to call methods via this client""" 3217 3218 def configs(self) -> 'Configs': 3219 """Return an instance of `Configs` to call methods via this client""" 3220 3221 def container_requests(self) -> 'ContainerRequests': 3222 """Return an instance of `ContainerRequests` to call methods via this client""" 3223 3224 def containers(self) -> 'Containers': 3225 """Return an instance of `Containers` to call methods via this client""" 3226 3227 def groups(self) -> 'Groups': 3228 """Return an instance of `Groups` to call methods via this client""" 3229 3230 def keep_services(self) -> 'KeepServices': 3231 """Return an instance of `KeepServices` to call methods via this client""" 3232 3233 def links(self) -> 'Links': 3234 """Return an instance of `Links` to call methods via this client""" 3235 3236 def logs(self) -> 'Logs': 3237 """Return an instance of `Logs` to call methods via this client""" 3238 3239 def sys(self) -> 'Sys': 3240 """Return an instance of `Sys` to call methods via this client""" 3241 3242 def user_agreements(self) -> 'UserAgreements': 3243 """Return an instance of `UserAgreements` to call methods via this client""" 3244 3245 def users(self) -> 'Users': 3246 """Return an instance of `Users` to call methods via this client""" 3247 3248 def virtual_machines(self) -> 'VirtualMachines': 3249 """Return an instance of `VirtualMachines` to call methods via this client""" 3250 3251 def vocabularies(self) -> 'Vocabularies': 3252 """Return an instance of `Vocabularies` to call methods via this client""" 3253 3254 def workflows(self) -> 'Workflows': 3255 """Return an instance of `Workflows` to call methods via this client"""
class
ArvadosAPIRequest(googleapiclient.http.HttpRequest, typing.Generic[~ST]):
27class ArvadosAPIRequest(googleapiclient.http.HttpRequest, Generic[ST]): 28 """Generic API request object 29 30 When you call an API method in the Arvados Python SDK, it returns a 31 request object. You usually call `execute()` on this object to submit the 32 request to your Arvados API server and retrieve the response. `execute()` 33 will return the type of object annotated in the subscript of 34 `ArvadosAPIRequest`. 35 """ 36 37 def execute(self, http: Optional[httplib2.Http]=None, num_retries: int=0) -> ST: 38 """Execute this request and return the response 39 40 Arguments: 41 42 * http: httplib2.Http | None --- The HTTP client object to use to 43 execute the request. If not specified, uses the HTTP client object 44 created with the API client object. 45 46 * num_retries: int --- The maximum number of times to retry this 47 request if the server returns a retryable failure. The API client 48 object also has a maximum number of retries specified when it is 49 instantiated (see `arvados.api.api_client`). This request is run 50 with the larger of that number and this argument. Default 0. 51 """
Generic API request object
When you call an API method in the Arvados Python SDK, it returns a
request object. You usually call execute() on this object to submit the
request to your Arvados API server and retrieve the response. execute()
will return the type of object annotated in the subscript of
ArvadosAPIRequest.
Inherited Members
- googleapiclient.http.HttpRequest
- HttpRequest
- uri
- method
- body
- headers
- methodId
- http
- postproc
- resumable
- response_callbacks
- body_size
- resumable_uri
- resumable_progress
- execute
- add_response_callback
- next_chunk
- to_json
- from_json
- null_postproc
class
ApiClientAuthorization(typing.TypedDict):
54class ApiClientAuthorization(TypedDict, total=False): 55 """Arvados API client authorization token 56 57 This resource represents an API token a user may use to authenticate an 58 Arvados API request. 59 60 This is the dictionary object that represents a single ApiClientAuthorization in Arvados 61 and is returned by most `ApiClientAuthorizations` methods. 62 The keys of the dictionary are documented below, along with their types. 63 Not every key may appear in every dictionary returned by an API call. 64 When a method doesn't return all the data, you can use its `select` parameter 65 to list the specific keys you need. Refer to the API documentation for details. 66 """ 67 etag: 'str' 68 """Object cache version.""" 69 api_token: 'str' 70 """The secret token that can be used to authorize Arvados API requests.""" 71 created_by_ip_address: 'str' 72 """The IP address of the client that created this token.""" 73 last_used_by_ip_address: 'str' 74 """The IP address of the client that last used this token.""" 75 last_used_at: 'str' 76 """The last time this token was used to authorize a request. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 77 expires_at: 'str' 78 """The time after which this token is no longer valid for authorization. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 79 created_at: 'str' 80 """The time this API client authorization was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 81 scopes: 'List' 82 """An array of strings identifying HTTP methods and API paths this token is 83 authorized to use. Refer to the [scopes reference][] for details. 84 85 [scopes reference]: https://doc.arvados.org/api/tokens.html#scopes 86 """ 87 uuid: 'str' 88 """This API client authorization's Arvados UUID, like `zzzzz-gj3su-12345abcde67890`."""
Arvados API client authorization token
This resource represents an API token a user may use to authenticate an Arvados API request.
This is the dictionary object that represents a single ApiClientAuthorization in Arvados
and is returned by most ApiClientAuthorizations methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
last_used_at: str
The last time this token was used to authorize a request. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
expires_at: str
The time after which this token is no longer valid for authorization. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
created_at: str
The time this API client authorization was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
scopes: List
An array of strings identifying HTTP methods and API paths this token is authorized to use. Refer to the scopes reference for details.
class
ApiClientAuthorizationList(typing.TypedDict):
91class ApiClientAuthorizationList(TypedDict, total=False): 92 """A list of ApiClientAuthorization objects. 93 94 This is the dictionary object returned when you call `ApiClientAuthorizations.list`. 95 If you just want to iterate all objects that match your search criteria, 96 consider using `arvados.util.keyset_list_all`. 97 If you work with this raw object, the keys of the dictionary are documented 98 below, along with their types. The `items` key maps to a list of matching 99 `ApiClientAuthorization` objects. 100 """ 101 kind: 'str' = 'arvados#apiClientAuthorizationList' 102 """Object type. Always arvados#apiClientAuthorizationList.""" 103 etag: 'str' 104 """List cache version.""" 105 items: 'List[ApiClientAuthorization]' 106 """An array of matching ApiClientAuthorization objects."""
A list of ApiClientAuthorization objects.
This is the dictionary object returned when you call ApiClientAuthorizations.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.keyset_list_all.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
ApiClientAuthorization objects.
class
ApiClientAuthorizations:
109class ApiClientAuthorizations: 110 """Methods to query and manipulate Arvados api client authorizations""" 111 112 def create(self, *, body: "Dict[Literal['api_client_authorization'], ApiClientAuthorization]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 113 """Create a new ApiClientAuthorization. 114 115 Required parameters: 116 117 * body: Dict[Literal['api_client_authorization'], ApiClientAuthorization] --- A dictionary with a single item `'api_client_authorization'`. 118 Its value is a `ApiClientAuthorization` dictionary defining the attributes to set. 119 120 Optional parameters: 121 122 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 123 124 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 125 126 * select: Optional[List] --- An array of names of attributes to return in the response. 127 """ 128 129 def create_system_auth(self, *, scopes: 'List' = ['all']) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 130 """Create a token for the system ("root") user. 131 132 Optional parameters: 133 134 * scopes: List --- An array of strings defining the scope of resources this token will be allowed to access. Refer to the [scopes reference][] for details. Default `['all']`. 135 136 [scopes reference]: https://doc.arvados.org/api/tokens.html#scopes 137 """ 138 139 def current(self) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 140 """Return all metadata for the token used to authorize this request.""" 141 142 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ApiClientAuthorization]': 143 """Delete an existing ApiClientAuthorization. 144 145 Required parameters: 146 147 * uuid: str --- The UUID of the ApiClientAuthorization to delete. 148 """ 149 150 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 151 """Get a ApiClientAuthorization record by UUID. 152 153 Required parameters: 154 155 * uuid: str --- The UUID of the ApiClientAuthorization to return. 156 157 Optional parameters: 158 159 * select: Optional[List] --- An array of names of attributes to return in the response. 160 """ 161 162 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[ApiClientAuthorizationList]': 163 """Retrieve a ApiClientAuthorizationList. 164 165 This method returns a single page of `ApiClientAuthorization` objects that match your search 166 criteria. If you just want to iterate all objects that match your search 167 criteria, consider using `arvados.util.keyset_list_all`. 168 169 Optional parameters: 170 171 * bypass_federation: bool --- If true, do not return results from other clusters in the 172 federation, only the cluster that received the request. 173 You must be an administrator to use this flag. Default `False`. 174 175 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 176 177 * count: str --- A string to determine result counting behavior. Supported values are: 178 179 * `"exact"`: The response will include an `items_available` field that 180 counts the number of objects that matched this search criteria, 181 including ones not included in `items`. 182 183 * `"none"`: The response will not include an `items_avaliable` 184 field. This improves performance by returning a result as soon as enough 185 `items` have been loaded for this result. 186 187 Default `'exact'`. 188 189 * distinct: bool --- If this is true, and multiple objects have the same values 190 for the attributes that you specify in the `select` parameter, then each unique 191 set of values will only be returned once in the result set. Default `False`. 192 193 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 194 Refer to the [filters reference][] for more information about how to write filters. 195 196 [filters reference]: https://doc.arvados.org/api/methods.html#filters 197 198 * limit: int --- The maximum number of objects to return in the result. 199 Note that the API may return fewer results than this if your request hits other 200 limits set by the administrator. Default `100`. 201 202 * offset: int --- Return matching objects starting from this index. 203 Note that result indexes may change if objects are modified in between a series 204 of list calls. Default `0`. 205 206 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 207 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 208 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 209 210 * select: Optional[List] --- An array of names of attributes to return from each matching object. 211 212 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 213 The keys of this object are attribute names. 214 Each value is either a single matching value or an array of matching values for that attribute. 215 The `filters` parameter is more flexible and preferred. 216 """ 217 218 def update(self, *, body: "Dict[Literal['api_client_authorization'], ApiClientAuthorization]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 219 """Update attributes of an existing ApiClientAuthorization. 220 221 Required parameters: 222 223 * body: Dict[Literal['api_client_authorization'], ApiClientAuthorization] --- A dictionary with a single item `'api_client_authorization'`. 224 Its value is a `ApiClientAuthorization` dictionary defining the attributes to set. 225 226 * uuid: str --- The UUID of the ApiClientAuthorization to update. 227 228 Optional parameters: 229 230 * select: Optional[List] --- An array of names of attributes to return in the response. 231 """
Methods to query and manipulate Arvados api client authorizations
def
create( self, *, body: Dict[Literal['api_client_authorization'], ApiClientAuthorization], cluster_id: Optional[str] = None, ensure_unique_name: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[ApiClientAuthorization]:
112 def create(self, *, body: "Dict[Literal['api_client_authorization'], ApiClientAuthorization]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 113 """Create a new ApiClientAuthorization. 114 115 Required parameters: 116 117 * body: Dict[Literal['api_client_authorization'], ApiClientAuthorization] --- A dictionary with a single item `'api_client_authorization'`. 118 Its value is a `ApiClientAuthorization` dictionary defining the attributes to set. 119 120 Optional parameters: 121 122 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 123 124 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 125 126 * select: Optional[List] --- An array of names of attributes to return in the response. 127 """
Create a new ApiClientAuthorization.
Required parameters:
- body: Dict[Literal[’api_client_authorization’], ApiClientAuthorization] — A dictionary with a single item
'api_client_authorization'. Its value is aApiClientAuthorizationdictionary defining the attributes to set.
Optional parameters:
cluster_id: Optional[str] — Cluster ID of a federated cluster where this object should be created.
ensure_unique_name: bool — If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
def
create_system_auth( self, *, scopes: List = ['all']) -> ArvadosAPIRequest[ApiClientAuthorization]:
129 def create_system_auth(self, *, scopes: 'List' = ['all']) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 130 """Create a token for the system ("root") user. 131 132 Optional parameters: 133 134 * scopes: List --- An array of strings defining the scope of resources this token will be allowed to access. Refer to the [scopes reference][] for details. Default `['all']`. 135 136 [scopes reference]: https://doc.arvados.org/api/tokens.html#scopes 137 """
Create a token for the system ("root") user.
Optional parameters:
- scopes: List — An array of strings defining the scope of resources this token will be allowed to access. Refer to the scopes reference for details. Default
['all'].
139 def current(self) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 140 """Return all metadata for the token used to authorize this request."""
Return all metadata for the token used to authorize this request.
142 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ApiClientAuthorization]': 143 """Delete an existing ApiClientAuthorization. 144 145 Required parameters: 146 147 * uuid: str --- The UUID of the ApiClientAuthorization to delete. 148 """
Delete an existing ApiClientAuthorization.
Required parameters:
- uuid: str — The UUID of the ApiClientAuthorization to delete.
def
get( self, *, uuid: str, select: Optional[List] = None) -> ArvadosAPIRequest[ApiClientAuthorization]:
150 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 151 """Get a ApiClientAuthorization record by UUID. 152 153 Required parameters: 154 155 * uuid: str --- The UUID of the ApiClientAuthorization to return. 156 157 Optional parameters: 158 159 * select: Optional[List] --- An array of names of attributes to return in the response. 160 """
Get a ApiClientAuthorization record by UUID.
Required parameters:
- uuid: str — The UUID of the ApiClientAuthorization to return.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
def
list( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, limit: int = 100, offset: int = 0, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[ApiClientAuthorizationList]:
162 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[ApiClientAuthorizationList]': 163 """Retrieve a ApiClientAuthorizationList. 164 165 This method returns a single page of `ApiClientAuthorization` objects that match your search 166 criteria. If you just want to iterate all objects that match your search 167 criteria, consider using `arvados.util.keyset_list_all`. 168 169 Optional parameters: 170 171 * bypass_federation: bool --- If true, do not return results from other clusters in the 172 federation, only the cluster that received the request. 173 You must be an administrator to use this flag. Default `False`. 174 175 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 176 177 * count: str --- A string to determine result counting behavior. Supported values are: 178 179 * `"exact"`: The response will include an `items_available` field that 180 counts the number of objects that matched this search criteria, 181 including ones not included in `items`. 182 183 * `"none"`: The response will not include an `items_avaliable` 184 field. This improves performance by returning a result as soon as enough 185 `items` have been loaded for this result. 186 187 Default `'exact'`. 188 189 * distinct: bool --- If this is true, and multiple objects have the same values 190 for the attributes that you specify in the `select` parameter, then each unique 191 set of values will only be returned once in the result set. Default `False`. 192 193 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 194 Refer to the [filters reference][] for more information about how to write filters. 195 196 [filters reference]: https://doc.arvados.org/api/methods.html#filters 197 198 * limit: int --- The maximum number of objects to return in the result. 199 Note that the API may return fewer results than this if your request hits other 200 limits set by the administrator. Default `100`. 201 202 * offset: int --- Return matching objects starting from this index. 203 Note that result indexes may change if objects are modified in between a series 204 of list calls. Default `0`. 205 206 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 207 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 208 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 209 210 * select: Optional[List] --- An array of names of attributes to return from each matching object. 211 212 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 213 The keys of this object are attribute names. 214 Each value is either a single matching value or an array of matching values for that attribute. 215 The `filters` parameter is more flexible and preferred. 216 """
Retrieve a ApiClientAuthorizationList.
This method returns a single page of ApiClientAuthorization objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.keyset_list_all.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
def
update( self, *, body: Dict[Literal['api_client_authorization'], ApiClientAuthorization], uuid: str, select: Optional[List] = None) -> ArvadosAPIRequest[ApiClientAuthorization]:
218 def update(self, *, body: "Dict[Literal['api_client_authorization'], ApiClientAuthorization]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ApiClientAuthorization]': 219 """Update attributes of an existing ApiClientAuthorization. 220 221 Required parameters: 222 223 * body: Dict[Literal['api_client_authorization'], ApiClientAuthorization] --- A dictionary with a single item `'api_client_authorization'`. 224 Its value is a `ApiClientAuthorization` dictionary defining the attributes to set. 225 226 * uuid: str --- The UUID of the ApiClientAuthorization to update. 227 228 Optional parameters: 229 230 * select: Optional[List] --- An array of names of attributes to return in the response. 231 """
Update attributes of an existing ApiClientAuthorization.
Required parameters:
body: Dict[Literal[’api_client_authorization’], ApiClientAuthorization] — A dictionary with a single item
'api_client_authorization'. Its value is aApiClientAuthorizationdictionary defining the attributes to set.uuid: str — The UUID of the ApiClientAuthorization to update.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
class
AuthorizedKey(typing.TypedDict):
234class AuthorizedKey(TypedDict, total=False): 235 """Arvados authorized public key 236 237 This resource represents a public key a user may use to authenticate themselves 238 to services on the cluster. Its primary use today is to store SSH keys for 239 virtual machines ("shell nodes"). It may be extended to store other keys in 240 the future. 241 242 This is the dictionary object that represents a single AuthorizedKey in Arvados 243 and is returned by most `AuthorizedKeys` methods. 244 The keys of the dictionary are documented below, along with their types. 245 Not every key may appear in every dictionary returned by an API call. 246 When a method doesn't return all the data, you can use its `select` parameter 247 to list the specific keys you need. Refer to the API documentation for details. 248 """ 249 etag: 'str' 250 """Object cache version.""" 251 uuid: 'str' 252 """This authorized key's Arvados UUID, like `zzzzz-fngyi-12345abcde67890`.""" 253 owner_uuid: 'str' 254 """The UUID of the user or group that owns this authorized key.""" 255 modified_by_user_uuid: 'str' 256 """The UUID of the user that last updated this authorized key.""" 257 modified_at: 'str' 258 """The time this authorized key was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 259 name: 'str' 260 """The name of this authorized key assigned by a user.""" 261 key_type: 'str' 262 """A string identifying what type of service uses this key. Supported values are: 263 264 * `"SSH"` 265 """ 266 authorized_user_uuid: 'str' 267 """The UUID of the Arvados user that is authorized by this key.""" 268 public_key: 'str' 269 """The full public key, in the format referenced by `key_type`.""" 270 expires_at: 'str' 271 """The time after which this key is no longer valid for authorization. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 272 created_at: 'str' 273 """The time this authorized key was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
Arvados authorized public key
This resource represents a public key a user may use to authenticate themselves to services on the cluster. Its primary use today is to store SSH keys for virtual machines ("shell nodes"). It may be extended to store other keys in the future.
This is the dictionary object that represents a single AuthorizedKey in Arvados
and is returned by most AuthorizedKeys methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
modified_at: str
The time this authorized key was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
class
AuthorizedKeyList(typing.TypedDict):
276class AuthorizedKeyList(TypedDict, total=False): 277 """A list of AuthorizedKey objects. 278 279 This is the dictionary object returned when you call `AuthorizedKeys.list`. 280 If you just want to iterate all objects that match your search criteria, 281 consider using `arvados.util.keyset_list_all`. 282 If you work with this raw object, the keys of the dictionary are documented 283 below, along with their types. The `items` key maps to a list of matching 284 `AuthorizedKey` objects. 285 """ 286 kind: 'str' = 'arvados#authorizedKeyList' 287 """Object type. Always arvados#authorizedKeyList.""" 288 etag: 'str' 289 """List cache version.""" 290 items: 'List[AuthorizedKey]' 291 """An array of matching AuthorizedKey objects."""
A list of AuthorizedKey objects.
This is the dictionary object returned when you call AuthorizedKeys.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.keyset_list_all.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
AuthorizedKey objects.
class
AuthorizedKeys:
294class AuthorizedKeys: 295 """Methods to query and manipulate Arvados authorized keys""" 296 297 def create(self, *, body: "Dict[Literal['authorized_key'], AuthorizedKey]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[AuthorizedKey]': 298 """Create a new AuthorizedKey. 299 300 Required parameters: 301 302 * body: Dict[Literal['authorized_key'], AuthorizedKey] --- A dictionary with a single item `'authorized_key'`. 303 Its value is a `AuthorizedKey` dictionary defining the attributes to set. 304 305 Optional parameters: 306 307 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 308 309 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 310 311 * select: Optional[List] --- An array of names of attributes to return in the response. 312 """ 313 314 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[AuthorizedKey]': 315 """Delete an existing AuthorizedKey. 316 317 Required parameters: 318 319 * uuid: str --- The UUID of the AuthorizedKey to delete. 320 """ 321 322 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[AuthorizedKey]': 323 """Get a AuthorizedKey record by UUID. 324 325 Required parameters: 326 327 * uuid: str --- The UUID of the AuthorizedKey to return. 328 329 Optional parameters: 330 331 * select: Optional[List] --- An array of names of attributes to return in the response. 332 """ 333 334 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[AuthorizedKeyList]': 335 """Retrieve a AuthorizedKeyList. 336 337 This method returns a single page of `AuthorizedKey` objects that match your search 338 criteria. If you just want to iterate all objects that match your search 339 criteria, consider using `arvados.util.keyset_list_all`. 340 341 Optional parameters: 342 343 * bypass_federation: bool --- If true, do not return results from other clusters in the 344 federation, only the cluster that received the request. 345 You must be an administrator to use this flag. Default `False`. 346 347 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 348 349 * count: str --- A string to determine result counting behavior. Supported values are: 350 351 * `"exact"`: The response will include an `items_available` field that 352 counts the number of objects that matched this search criteria, 353 including ones not included in `items`. 354 355 * `"none"`: The response will not include an `items_avaliable` 356 field. This improves performance by returning a result as soon as enough 357 `items` have been loaded for this result. 358 359 Default `'exact'`. 360 361 * distinct: bool --- If this is true, and multiple objects have the same values 362 for the attributes that you specify in the `select` parameter, then each unique 363 set of values will only be returned once in the result set. Default `False`. 364 365 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 366 Refer to the [filters reference][] for more information about how to write filters. 367 368 [filters reference]: https://doc.arvados.org/api/methods.html#filters 369 370 * limit: int --- The maximum number of objects to return in the result. 371 Note that the API may return fewer results than this if your request hits other 372 limits set by the administrator. Default `100`. 373 374 * offset: int --- Return matching objects starting from this index. 375 Note that result indexes may change if objects are modified in between a series 376 of list calls. Default `0`. 377 378 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 379 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 380 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 381 382 * select: Optional[List] --- An array of names of attributes to return from each matching object. 383 384 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 385 The keys of this object are attribute names. 386 Each value is either a single matching value or an array of matching values for that attribute. 387 The `filters` parameter is more flexible and preferred. 388 """ 389 390 def update(self, *, body: "Dict[Literal['authorized_key'], AuthorizedKey]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[AuthorizedKey]': 391 """Update attributes of an existing AuthorizedKey. 392 393 Required parameters: 394 395 * body: Dict[Literal['authorized_key'], AuthorizedKey] --- A dictionary with a single item `'authorized_key'`. 396 Its value is a `AuthorizedKey` dictionary defining the attributes to set. 397 398 * uuid: str --- The UUID of the AuthorizedKey to update. 399 400 Optional parameters: 401 402 * select: Optional[List] --- An array of names of attributes to return in the response. 403 """
Methods to query and manipulate Arvados authorized keys
def
create( self, *, body: Dict[Literal['authorized_key'], AuthorizedKey], cluster_id: Optional[str] = None, ensure_unique_name: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[AuthorizedKey]:
297 def create(self, *, body: "Dict[Literal['authorized_key'], AuthorizedKey]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[AuthorizedKey]': 298 """Create a new AuthorizedKey. 299 300 Required parameters: 301 302 * body: Dict[Literal['authorized_key'], AuthorizedKey] --- A dictionary with a single item `'authorized_key'`. 303 Its value is a `AuthorizedKey` dictionary defining the attributes to set. 304 305 Optional parameters: 306 307 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 308 309 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 310 311 * select: Optional[List] --- An array of names of attributes to return in the response. 312 """
Create a new AuthorizedKey.
Required parameters:
- body: Dict[Literal[’authorized_key’], AuthorizedKey] — A dictionary with a single item
'authorized_key'. Its value is aAuthorizedKeydictionary defining the attributes to set.
Optional parameters:
cluster_id: Optional[str] — Cluster ID of a federated cluster where this object should be created.
ensure_unique_name: bool — If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
314 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[AuthorizedKey]': 315 """Delete an existing AuthorizedKey. 316 317 Required parameters: 318 319 * uuid: str --- The UUID of the AuthorizedKey to delete. 320 """
Delete an existing AuthorizedKey.
Required parameters:
- uuid: str — The UUID of the AuthorizedKey to delete.
322 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[AuthorizedKey]': 323 """Get a AuthorizedKey record by UUID. 324 325 Required parameters: 326 327 * uuid: str --- The UUID of the AuthorizedKey to return. 328 329 Optional parameters: 330 331 * select: Optional[List] --- An array of names of attributes to return in the response. 332 """
Get a AuthorizedKey record by UUID.
Required parameters:
- uuid: str — The UUID of the AuthorizedKey to return.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
def
list( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, limit: int = 100, offset: int = 0, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[AuthorizedKeyList]:
334 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[AuthorizedKeyList]': 335 """Retrieve a AuthorizedKeyList. 336 337 This method returns a single page of `AuthorizedKey` objects that match your search 338 criteria. If you just want to iterate all objects that match your search 339 criteria, consider using `arvados.util.keyset_list_all`. 340 341 Optional parameters: 342 343 * bypass_federation: bool --- If true, do not return results from other clusters in the 344 federation, only the cluster that received the request. 345 You must be an administrator to use this flag. Default `False`. 346 347 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 348 349 * count: str --- A string to determine result counting behavior. Supported values are: 350 351 * `"exact"`: The response will include an `items_available` field that 352 counts the number of objects that matched this search criteria, 353 including ones not included in `items`. 354 355 * `"none"`: The response will not include an `items_avaliable` 356 field. This improves performance by returning a result as soon as enough 357 `items` have been loaded for this result. 358 359 Default `'exact'`. 360 361 * distinct: bool --- If this is true, and multiple objects have the same values 362 for the attributes that you specify in the `select` parameter, then each unique 363 set of values will only be returned once in the result set. Default `False`. 364 365 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 366 Refer to the [filters reference][] for more information about how to write filters. 367 368 [filters reference]: https://doc.arvados.org/api/methods.html#filters 369 370 * limit: int --- The maximum number of objects to return in the result. 371 Note that the API may return fewer results than this if your request hits other 372 limits set by the administrator. Default `100`. 373 374 * offset: int --- Return matching objects starting from this index. 375 Note that result indexes may change if objects are modified in between a series 376 of list calls. Default `0`. 377 378 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 379 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 380 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 381 382 * select: Optional[List] --- An array of names of attributes to return from each matching object. 383 384 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 385 The keys of this object are attribute names. 386 Each value is either a single matching value or an array of matching values for that attribute. 387 The `filters` parameter is more flexible and preferred. 388 """
Retrieve a AuthorizedKeyList.
This method returns a single page of AuthorizedKey objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.keyset_list_all.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
def
update( self, *, body: Dict[Literal['authorized_key'], AuthorizedKey], uuid: str, select: Optional[List] = None) -> ArvadosAPIRequest[AuthorizedKey]:
390 def update(self, *, body: "Dict[Literal['authorized_key'], AuthorizedKey]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[AuthorizedKey]': 391 """Update attributes of an existing AuthorizedKey. 392 393 Required parameters: 394 395 * body: Dict[Literal['authorized_key'], AuthorizedKey] --- A dictionary with a single item `'authorized_key'`. 396 Its value is a `AuthorizedKey` dictionary defining the attributes to set. 397 398 * uuid: str --- The UUID of the AuthorizedKey to update. 399 400 Optional parameters: 401 402 * select: Optional[List] --- An array of names of attributes to return in the response. 403 """
Update attributes of an existing AuthorizedKey.
Required parameters:
body: Dict[Literal[’authorized_key’], AuthorizedKey] — A dictionary with a single item
'authorized_key'. Its value is aAuthorizedKeydictionary defining the attributes to set.uuid: str — The UUID of the AuthorizedKey to update.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
class
Collection(typing.TypedDict):
406class Collection(TypedDict, total=False): 407 """Arvados data collection 408 409 A collection describes how a set of files is stored in data blocks in Keep, 410 along with associated metadata. 411 412 This is the dictionary object that represents a single Collection in Arvados 413 and is returned by most `Collections` methods. 414 The keys of the dictionary are documented below, along with their types. 415 Not every key may appear in every dictionary returned by an API call. 416 When a method doesn't return all the data, you can use its `select` parameter 417 to list the specific keys you need. Refer to the API documentation for details. 418 """ 419 etag: 'str' 420 """Object cache version.""" 421 owner_uuid: 'str' 422 """The UUID of the user or group that owns this collection.""" 423 created_at: 'str' 424 """The time this collection was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 425 modified_by_user_uuid: 'str' 426 """The UUID of the user that last updated this collection.""" 427 modified_at: 'str' 428 """The time this collection was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 429 portable_data_hash: 'str' 430 """The portable data hash of this collection. This string provides a unique 431 and stable reference to these contents. 432 """ 433 replication_desired: 'int' 434 """The number of copies that should be made for data in this collection.""" 435 replication_confirmed_at: 'str' 436 """The last time the cluster confirmed that it met `replication_confirmed` 437 for this collection. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`. 438 """ 439 replication_confirmed: 'int' 440 """The number of copies of data in this collection that the cluster has confirmed 441 exist in storage. 442 """ 443 uuid: 'str' 444 """This collection's Arvados UUID, like `zzzzz-4zz18-12345abcde67890`.""" 445 manifest_text: 'str' 446 """The manifest text that describes how files are constructed from data blocks 447 in this collection. Refer to the [manifest format][] reference for details. 448 449 [manifest format]: https://doc.arvados.org/architecture/manifest-format.html 450 """ 451 name: 'str' 452 """The name of this collection assigned by a user.""" 453 description: 'str' 454 """A longer HTML description of this collection assigned by a user. 455 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 456 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 457 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 458 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 459 """ 460 properties: 'Dict[str, Any]' 461 """A hash of arbitrary metadata for this collection. 462 Some keys may be reserved by Arvados or defined by a configured vocabulary. 463 Refer to the [metadata properties reference][] for details. 464 465 [metadata properties reference]: https://doc.arvados.org/api/properties.html 466 """ 467 delete_at: 'str' 468 """The time this collection will be permanently deleted. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 469 trash_at: 'str' 470 """The time this collection will be trashed. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 471 is_trashed: 'bool' 472 """A boolean flag to indicate whether or not this collection is trashed.""" 473 storage_classes_desired: 'List' 474 """An array of strings identifying the storage class(es) that should be used 475 for data in this collection. Storage classes are configured by the cluster administrator. 476 """ 477 storage_classes_confirmed: 'List' 478 """An array of strings identifying the storage class(es) the cluster has 479 confirmed have a copy of this collection's data. 480 """ 481 storage_classes_confirmed_at: 'str' 482 """The last time the cluster confirmed that data was stored on the storage 483 class(es) in `storage_classes_confirmed`. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`. 484 """ 485 current_version_uuid: 'str' 486 """The UUID of the current version of this collection.""" 487 version: 'int' 488 """An integer that counts which version of a collection this record 489 represents. Refer to [collection versioning][] for details. This attribute is 490 read-only. 491 492 [collection versioning]: https://doc.arvados.org/user/topics/collection-versioning.html 493 """ 494 preserve_version: 'bool' 495 """A boolean flag to indicate whether this specific version of this collection 496 should be persisted in cluster storage. 497 """ 498 file_count: 'int' 499 """The number of files represented in this collection's `manifest_text`. 500 This attribute is read-only. 501 """ 502 file_size_total: 'int' 503 """The total size in bytes of files represented in this collection's `manifest_text`. 504 This attribute is read-only. 505 """
Arvados data collection
A collection describes how a set of files is stored in data blocks in Keep, along with associated metadata.
This is the dictionary object that represents a single Collection in Arvados
and is returned by most Collections methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
created_at: str
The time this collection was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
modified_at: str
The time this collection was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
portable_data_hash: str
The portable data hash of this collection. This string provides a unique and stable reference to these contents.
replication_confirmed_at: str
The last time the cluster confirmed that it met replication_confirmed
for this collection. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
replication_confirmed: int
The number of copies of data in this collection that the cluster has confirmed exist in storage.
manifest_text: str
The manifest text that describes how files are constructed from data blocks in this collection. Refer to the manifest format reference for details.
description: str
A longer HTML description of this collection assigned by a user.
Allowed HTML tags are a, b, blockquote, br, code,
del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr,
i, img, kbd, li, ol, p, pre,
s, section, span, strong, sub, sup, and ul.
properties: Dict[str, Any]
A hash of arbitrary metadata for this collection. Some keys may be reserved by Arvados or defined by a configured vocabulary. Refer to the metadata properties reference for details.
delete_at: str
The time this collection will be permanently deleted. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
trash_at: str
The time this collection will be trashed. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
storage_classes_desired: List
An array of strings identifying the storage class(es) that should be used for data in this collection. Storage classes are configured by the cluster administrator.
storage_classes_confirmed: List
An array of strings identifying the storage class(es) the cluster has confirmed have a copy of this collection’s data.
storage_classes_confirmed_at: str
The last time the cluster confirmed that data was stored on the storage
class(es) in storage_classes_confirmed. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
version: int
An integer that counts which version of a collection this record represents. Refer to collection versioning for details. This attribute is read-only.
preserve_version: bool
A boolean flag to indicate whether this specific version of this collection should be persisted in cluster storage.
file_count: int
The number of files represented in this collection’s manifest_text.
This attribute is read-only.
file_size_total: int
The total size in bytes of files represented in this collection’s manifest_text.
This attribute is read-only.
class
CollectionList(typing.TypedDict):
508class CollectionList(TypedDict, total=False): 509 """A list of Collection objects. 510 511 This is the dictionary object returned when you call `Collections.list`. 512 If you just want to iterate all objects that match your search criteria, 513 consider using `arvados.util.keyset_list_all`. 514 If you work with this raw object, the keys of the dictionary are documented 515 below, along with their types. The `items` key maps to a list of matching 516 `Collection` objects. 517 """ 518 kind: 'str' = 'arvados#collectionList' 519 """Object type. Always arvados#collectionList.""" 520 etag: 'str' 521 """List cache version.""" 522 items: 'List[Collection]' 523 """An array of matching Collection objects."""
A list of Collection objects.
This is the dictionary object returned when you call Collections.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.keyset_list_all.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
Collection objects.
class
Collections:
526class Collections: 527 """Methods to query and manipulate Arvados collections""" 528 529 def create(self, *, body: "Dict[Literal['collection'], Collection]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, replace_files: 'Optional[Dict[str, Any]]' = None, replace_segments: 'Optional[Dict[str, Any]]' = None, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 530 """Create a new Collection. 531 532 Required parameters: 533 534 * body: Dict[Literal['collection'], Collection] --- A dictionary with a single item `'collection'`. 535 Its value is a `Collection` dictionary defining the attributes to set. 536 537 Optional parameters: 538 539 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 540 541 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 542 543 * replace_files: Optional[Dict[str, Any]] --- Add, delete, and replace files and directories with new content 544 and/or content from other collections. Refer to the 545 [replace_files reference][] for details. 546 547 [replace_files reference]: https://doc.arvados.org/api/methods/collections.html#replace_files 548 549 * replace_segments: Optional[Dict[str, Any]] --- Replace existing block segments in the collection with new segments. 550 Refer to the [replace_segments reference][] for details. 551 552 [replace_segments reference]: https://doc.arvados.org/api/methods/collections.html#replace_segments 553 554 * select: Optional[List] --- An array of names of attributes to return in the response. 555 """ 556 557 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 558 """Delete an existing Collection. 559 560 Required parameters: 561 562 * uuid: str --- The UUID of the Collection to delete. 563 """ 564 565 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 566 """Get a Collection record by UUID. 567 568 Required parameters: 569 570 * uuid: str --- The UUID of the Collection to return. 571 572 Optional parameters: 573 574 * include_trash: bool --- Show collection even if its `is_trashed` attribute is true. Default `False`. 575 576 * select: Optional[List] --- An array of names of attributes to return in the response. 577 """ 578 579 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, include_old_versions: 'bool' = False, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[CollectionList]': 580 """Retrieve a CollectionList. 581 582 This method returns a single page of `Collection` objects that match your search 583 criteria. If you just want to iterate all objects that match your search 584 criteria, consider using `arvados.util.keyset_list_all`. 585 586 Optional parameters: 587 588 * bypass_federation: bool --- If true, do not return results from other clusters in the 589 federation, only the cluster that received the request. 590 You must be an administrator to use this flag. Default `False`. 591 592 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 593 594 * count: str --- A string to determine result counting behavior. Supported values are: 595 596 * `"exact"`: The response will include an `items_available` field that 597 counts the number of objects that matched this search criteria, 598 including ones not included in `items`. 599 600 * `"none"`: The response will not include an `items_avaliable` 601 field. This improves performance by returning a result as soon as enough 602 `items` have been loaded for this result. 603 604 Default `'exact'`. 605 606 * distinct: bool --- If this is true, and multiple objects have the same values 607 for the attributes that you specify in the `select` parameter, then each unique 608 set of values will only be returned once in the result set. Default `False`. 609 610 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 611 Refer to the [filters reference][] for more information about how to write filters. 612 613 [filters reference]: https://doc.arvados.org/api/methods.html#filters 614 615 * include_old_versions: bool --- Include past collection versions. Default `False`. 616 617 * include_trash: bool --- Include collections whose `is_trashed` attribute is true. Default `False`. 618 619 * limit: int --- The maximum number of objects to return in the result. 620 Note that the API may return fewer results than this if your request hits other 621 limits set by the administrator. Default `100`. 622 623 * offset: int --- Return matching objects starting from this index. 624 Note that result indexes may change if objects are modified in between a series 625 of list calls. Default `0`. 626 627 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 628 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 629 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 630 631 * select: Optional[List] --- An array of names of attributes to return from each matching object. 632 633 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 634 The keys of this object are attribute names. 635 Each value is either a single matching value or an array of matching values for that attribute. 636 The `filters` parameter is more flexible and preferred. 637 """ 638 639 def provenance(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 640 """Detail the provenance of a given collection. 641 642 Required parameters: 643 644 * uuid: str --- The UUID of the Collection to query. 645 """ 646 647 def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 648 """Trash a collection. 649 650 Required parameters: 651 652 * uuid: str --- The UUID of the Collection to update. 653 """ 654 655 def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 656 """Untrash a collection. 657 658 Required parameters: 659 660 * uuid: str --- The UUID of the Collection to update. 661 """ 662 663 def update(self, *, body: "Dict[Literal['collection'], Collection]", uuid: 'str', replace_files: 'Optional[Dict[str, Any]]' = None, replace_segments: 'Optional[Dict[str, Any]]' = None, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 664 """Update attributes of an existing Collection. 665 666 Required parameters: 667 668 * body: Dict[Literal['collection'], Collection] --- A dictionary with a single item `'collection'`. 669 Its value is a `Collection` dictionary defining the attributes to set. 670 671 * uuid: str --- The UUID of the Collection to update. 672 673 Optional parameters: 674 675 * replace_files: Optional[Dict[str, Any]] --- Add, delete, and replace files and directories with new content 676 and/or content from other collections. Refer to the 677 [replace_files reference][] for details. 678 679 [replace_files reference]: https://doc.arvados.org/api/methods/collections.html#replace_files 680 681 * replace_segments: Optional[Dict[str, Any]] --- Replace existing block segments in the collection with new segments. 682 Refer to the [replace_segments reference][] for details. 683 684 [replace_segments reference]: https://doc.arvados.org/api/methods/collections.html#replace_segments 685 686 * select: Optional[List] --- An array of names of attributes to return in the response. 687 """ 688 689 def used_by(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 690 """Detail where a given collection has been used. 691 692 Required parameters: 693 694 * uuid: str --- The UUID of the Collection to query. 695 """
Methods to query and manipulate Arvados collections
def
create( self, *, body: Dict[Literal['collection'], Collection], cluster_id: Optional[str] = None, ensure_unique_name: bool = False, replace_files: Optional[Dict[str, Any]] = None, replace_segments: Optional[Dict[str, Any]] = None, select: Optional[List] = None) -> ArvadosAPIRequest[Collection]:
529 def create(self, *, body: "Dict[Literal['collection'], Collection]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, replace_files: 'Optional[Dict[str, Any]]' = None, replace_segments: 'Optional[Dict[str, Any]]' = None, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 530 """Create a new Collection. 531 532 Required parameters: 533 534 * body: Dict[Literal['collection'], Collection] --- A dictionary with a single item `'collection'`. 535 Its value is a `Collection` dictionary defining the attributes to set. 536 537 Optional parameters: 538 539 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 540 541 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 542 543 * replace_files: Optional[Dict[str, Any]] --- Add, delete, and replace files and directories with new content 544 and/or content from other collections. Refer to the 545 [replace_files reference][] for details. 546 547 [replace_files reference]: https://doc.arvados.org/api/methods/collections.html#replace_files 548 549 * replace_segments: Optional[Dict[str, Any]] --- Replace existing block segments in the collection with new segments. 550 Refer to the [replace_segments reference][] for details. 551 552 [replace_segments reference]: https://doc.arvados.org/api/methods/collections.html#replace_segments 553 554 * select: Optional[List] --- An array of names of attributes to return in the response. 555 """
Create a new Collection.
Required parameters:
- body: Dict[Literal[’collection’], Collection] — A dictionary with a single item
'collection'. Its value is aCollectiondictionary defining the attributes to set.
Optional parameters:
cluster_id: Optional[str] — Cluster ID of a federated cluster where this object should be created.
ensure_unique_name: bool — If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default
False.replace_files: Optional[Dict[str, Any]] — Add, delete, and replace files and directories with new content and/or content from other collections. Refer to the replace_files reference for details.
replace_segments: Optional[Dict[str, Any]] — Replace existing block segments in the collection with new segments. Refer to the replace_segments reference for details.
select: Optional[List] — An array of names of attributes to return in the response.
557 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 558 """Delete an existing Collection. 559 560 Required parameters: 561 562 * uuid: str --- The UUID of the Collection to delete. 563 """
Delete an existing Collection.
Required parameters:
- uuid: str — The UUID of the Collection to delete.
def
get( self, *, uuid: str, include_trash: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[Collection]:
565 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 566 """Get a Collection record by UUID. 567 568 Required parameters: 569 570 * uuid: str --- The UUID of the Collection to return. 571 572 Optional parameters: 573 574 * include_trash: bool --- Show collection even if its `is_trashed` attribute is true. Default `False`. 575 576 * select: Optional[List] --- An array of names of attributes to return in the response. 577 """
Get a Collection record by UUID.
Required parameters:
- uuid: str — The UUID of the Collection to return.
Optional parameters:
include_trash: bool — Show collection even if its
is_trashedattribute is true. DefaultFalse.select: Optional[List] — An array of names of attributes to return in the response.
def
list( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, include_old_versions: bool = False, include_trash: bool = False, limit: int = 100, offset: int = 0, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[CollectionList]:
579 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, include_old_versions: 'bool' = False, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[CollectionList]': 580 """Retrieve a CollectionList. 581 582 This method returns a single page of `Collection` objects that match your search 583 criteria. If you just want to iterate all objects that match your search 584 criteria, consider using `arvados.util.keyset_list_all`. 585 586 Optional parameters: 587 588 * bypass_federation: bool --- If true, do not return results from other clusters in the 589 federation, only the cluster that received the request. 590 You must be an administrator to use this flag. Default `False`. 591 592 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 593 594 * count: str --- A string to determine result counting behavior. Supported values are: 595 596 * `"exact"`: The response will include an `items_available` field that 597 counts the number of objects that matched this search criteria, 598 including ones not included in `items`. 599 600 * `"none"`: The response will not include an `items_avaliable` 601 field. This improves performance by returning a result as soon as enough 602 `items` have been loaded for this result. 603 604 Default `'exact'`. 605 606 * distinct: bool --- If this is true, and multiple objects have the same values 607 for the attributes that you specify in the `select` parameter, then each unique 608 set of values will only be returned once in the result set. Default `False`. 609 610 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 611 Refer to the [filters reference][] for more information about how to write filters. 612 613 [filters reference]: https://doc.arvados.org/api/methods.html#filters 614 615 * include_old_versions: bool --- Include past collection versions. Default `False`. 616 617 * include_trash: bool --- Include collections whose `is_trashed` attribute is true. Default `False`. 618 619 * limit: int --- The maximum number of objects to return in the result. 620 Note that the API may return fewer results than this if your request hits other 621 limits set by the administrator. Default `100`. 622 623 * offset: int --- Return matching objects starting from this index. 624 Note that result indexes may change if objects are modified in between a series 625 of list calls. Default `0`. 626 627 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 628 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 629 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 630 631 * select: Optional[List] --- An array of names of attributes to return from each matching object. 632 633 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 634 The keys of this object are attribute names. 635 Each value is either a single matching value or an array of matching values for that attribute. 636 The `filters` parameter is more flexible and preferred. 637 """
Retrieve a CollectionList.
This method returns a single page of Collection objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.keyset_list_all.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
include_old_versions: bool — Include past collection versions. Default
False.include_trash: bool — Include collections whose
is_trashedattribute is true. DefaultFalse.limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
639 def provenance(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 640 """Detail the provenance of a given collection. 641 642 Required parameters: 643 644 * uuid: str --- The UUID of the Collection to query. 645 """
Detail the provenance of a given collection.
Required parameters:
- uuid: str — The UUID of the Collection to query.
647 def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 648 """Trash a collection. 649 650 Required parameters: 651 652 * uuid: str --- The UUID of the Collection to update. 653 """
Trash a collection.
Required parameters:
- uuid: str — The UUID of the Collection to update.
655 def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 656 """Untrash a collection. 657 658 Required parameters: 659 660 * uuid: str --- The UUID of the Collection to update. 661 """
Untrash a collection.
Required parameters:
- uuid: str — The UUID of the Collection to update.
def
update( self, *, body: Dict[Literal['collection'], Collection], uuid: str, replace_files: Optional[Dict[str, Any]] = None, replace_segments: Optional[Dict[str, Any]] = None, select: Optional[List] = None) -> ArvadosAPIRequest[Collection]:
663 def update(self, *, body: "Dict[Literal['collection'], Collection]", uuid: 'str', replace_files: 'Optional[Dict[str, Any]]' = None, replace_segments: 'Optional[Dict[str, Any]]' = None, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 664 """Update attributes of an existing Collection. 665 666 Required parameters: 667 668 * body: Dict[Literal['collection'], Collection] --- A dictionary with a single item `'collection'`. 669 Its value is a `Collection` dictionary defining the attributes to set. 670 671 * uuid: str --- The UUID of the Collection to update. 672 673 Optional parameters: 674 675 * replace_files: Optional[Dict[str, Any]] --- Add, delete, and replace files and directories with new content 676 and/or content from other collections. Refer to the 677 [replace_files reference][] for details. 678 679 [replace_files reference]: https://doc.arvados.org/api/methods/collections.html#replace_files 680 681 * replace_segments: Optional[Dict[str, Any]] --- Replace existing block segments in the collection with new segments. 682 Refer to the [replace_segments reference][] for details. 683 684 [replace_segments reference]: https://doc.arvados.org/api/methods/collections.html#replace_segments 685 686 * select: Optional[List] --- An array of names of attributes to return in the response. 687 """
Update attributes of an existing Collection.
Required parameters:
body: Dict[Literal[’collection’], Collection] — A dictionary with a single item
'collection'. Its value is aCollectiondictionary defining the attributes to set.uuid: str — The UUID of the Collection to update.
Optional parameters:
replace_files: Optional[Dict[str, Any]] — Add, delete, and replace files and directories with new content and/or content from other collections. Refer to the replace_files reference for details.
replace_segments: Optional[Dict[str, Any]] — Replace existing block segments in the collection with new segments. Refer to the replace_segments reference for details.
select: Optional[List] — An array of names of attributes to return in the response.
689 def used_by(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 690 """Detail where a given collection has been used. 691 692 Required parameters: 693 694 * uuid: str --- The UUID of the Collection to query. 695 """
Detail where a given collection has been used.
Required parameters:
- uuid: str — The UUID of the Collection to query.
class
ComputedPermission(typing.TypedDict):
698class ComputedPermission(TypedDict, total=False): 699 """Arvados computed permission 700 701 Computed permissions do not correspond directly to any Arvados resource, but 702 provide a simple way to query the entire graph of permissions granted to 703 users and groups. 704 705 This is the dictionary object that represents a single ComputedPermission in Arvados 706 and is returned by most `ComputedPermissions` methods. 707 The keys of the dictionary are documented below, along with their types. 708 Not every key may appear in every dictionary returned by an API call. 709 When a method doesn't return all the data, you can use its `select` parameter 710 to list the specific keys you need. Refer to the API documentation for details. 711 """ 712 user_uuid: 'str' 713 """The UUID of the Arvados user who has this permission.""" 714 target_uuid: 'str' 715 """The UUID of the Arvados object the user has access to.""" 716 perm_level: 'str' 717 """A string representing the user's level of access to the target object. 718 Possible values are: 719 720 * `"can_read"` 721 * `"can_write"` 722 * `"can_manage"` 723 """
Arvados computed permission
Computed permissions do not correspond directly to any Arvados resource, but provide a simple way to query the entire graph of permissions granted to users and groups.
This is the dictionary object that represents a single ComputedPermission in Arvados
and is returned by most ComputedPermissions methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
class
ComputedPermissionList(typing.TypedDict):
726class ComputedPermissionList(TypedDict, total=False): 727 """A list of ComputedPermission objects. 728 729 This is the dictionary object returned when you call `ComputedPermissions.list`. 730 If you just want to iterate all objects that match your search criteria, 731 consider using `arvados.util.iter_computed_permissions`. 732 If you work with this raw object, the keys of the dictionary are documented 733 below, along with their types. The `items` key maps to a list of matching 734 `ComputedPermission` objects. 735 """ 736 kind: 'str' = 'arvados#computedPermissionList' 737 """Object type. Always arvados#computedPermissionList.""" 738 etag: 'str' 739 """List cache version.""" 740 items: 'List[ComputedPermission]' 741 """An array of matching ComputedPermission objects."""
A list of ComputedPermission objects.
This is the dictionary object returned when you call ComputedPermissions.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.iter_computed_permissions.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
ComputedPermission objects.
class
ComputedPermissions:
744class ComputedPermissions: 745 """Methods to query and manipulate Arvados computed permissions""" 746 747 def list(self, *, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[ComputedPermissionList]': 748 """Retrieve a ComputedPermissionList. 749 750 This method returns a single page of `ComputedPermission` objects that match your search 751 criteria. If you just want to iterate all objects that match your search 752 criteria, consider using `arvados.util.iter_computed_permissions`. 753 754 Optional parameters: 755 756 * count: str --- A string to determine result counting behavior. Supported values are: 757 758 * `"exact"`: The response will include an `items_available` field that 759 counts the number of objects that matched this search criteria, 760 including ones not included in `items`. 761 762 * `"none"`: The response will not include an `items_avaliable` 763 field. This improves performance by returning a result as soon as enough 764 `items` have been loaded for this result. 765 766 Default `'exact'`. 767 768 * distinct: bool --- If this is true, and multiple objects have the same values 769 for the attributes that you specify in the `select` parameter, then each unique 770 set of values will only be returned once in the result set. Default `False`. 771 772 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 773 Refer to the [filters reference][] for more information about how to write filters. 774 775 [filters reference]: https://doc.arvados.org/api/methods.html#filters 776 777 * limit: int --- The maximum number of objects to return in the result. 778 Note that the API may return fewer results than this if your request hits other 779 limits set by the administrator. Default `100`. 780 781 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 782 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 783 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 784 785 * select: Optional[List] --- An array of names of attributes to return from each matching object. 786 787 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 788 The keys of this object are attribute names. 789 Each value is either a single matching value or an array of matching values for that attribute. 790 The `filters` parameter is more flexible and preferred. 791 """
Methods to query and manipulate Arvados computed permissions
def
list( self, *, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, limit: int = 100, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[ComputedPermissionList]:
747 def list(self, *, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[ComputedPermissionList]': 748 """Retrieve a ComputedPermissionList. 749 750 This method returns a single page of `ComputedPermission` objects that match your search 751 criteria. If you just want to iterate all objects that match your search 752 criteria, consider using `arvados.util.iter_computed_permissions`. 753 754 Optional parameters: 755 756 * count: str --- A string to determine result counting behavior. Supported values are: 757 758 * `"exact"`: The response will include an `items_available` field that 759 counts the number of objects that matched this search criteria, 760 including ones not included in `items`. 761 762 * `"none"`: The response will not include an `items_avaliable` 763 field. This improves performance by returning a result as soon as enough 764 `items` have been loaded for this result. 765 766 Default `'exact'`. 767 768 * distinct: bool --- If this is true, and multiple objects have the same values 769 for the attributes that you specify in the `select` parameter, then each unique 770 set of values will only be returned once in the result set. Default `False`. 771 772 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 773 Refer to the [filters reference][] for more information about how to write filters. 774 775 [filters reference]: https://doc.arvados.org/api/methods.html#filters 776 777 * limit: int --- The maximum number of objects to return in the result. 778 Note that the API may return fewer results than this if your request hits other 779 limits set by the administrator. Default `100`. 780 781 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 782 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 783 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 784 785 * select: Optional[List] --- An array of names of attributes to return from each matching object. 786 787 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 788 The keys of this object are attribute names. 789 Each value is either a single matching value or an array of matching values for that attribute. 790 The `filters` parameter is more flexible and preferred. 791 """
Retrieve a ComputedPermissionList.
This method returns a single page of ComputedPermission objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.iter_computed_permissions.
Optional parameters:
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
class
Configs:
794class Configs: 795 """Methods to query and manipulate Arvados configs""" 796 797 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 798 """Get this cluster's public configuration settings."""
Methods to query and manipulate Arvados configs
class
ContainerRequest(typing.TypedDict):
801class ContainerRequest(TypedDict, total=False): 802 """Arvados container request 803 804 A container request represents a user's request that Arvados do some compute 805 work, along with full details about what work should be done. Arvados will 806 attempt to fulfill the request by mapping it to a matching container record, 807 running the work on demand if necessary. 808 809 This is the dictionary object that represents a single ContainerRequest in Arvados 810 and is returned by most `ContainerRequests` methods. 811 The keys of the dictionary are documented below, along with their types. 812 Not every key may appear in every dictionary returned by an API call. 813 When a method doesn't return all the data, you can use its `select` parameter 814 to list the specific keys you need. Refer to the API documentation for details. 815 """ 816 etag: 'str' 817 """Object cache version.""" 818 uuid: 'str' 819 """This container request's Arvados UUID, like `zzzzz-xvhdp-12345abcde67890`.""" 820 owner_uuid: 'str' 821 """The UUID of the user or group that owns this container request.""" 822 created_at: 'str' 823 """The time this container request was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 824 modified_at: 'str' 825 """The time this container request was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 826 modified_by_user_uuid: 'str' 827 """The UUID of the user that last updated this container request.""" 828 name: 'str' 829 """The name of this container request assigned by a user.""" 830 description: 'str' 831 """A longer HTML description of this container request assigned by a user. 832 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 833 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 834 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 835 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 836 """ 837 properties: 'Dict[str, Any]' 838 """A hash of arbitrary metadata for this container request. 839 Some keys may be reserved by Arvados or defined by a configured vocabulary. 840 Refer to the [metadata properties reference][] for details. 841 842 [metadata properties reference]: https://doc.arvados.org/api/properties.html 843 """ 844 state: 'str' 845 """A string indicating where this container request is in its lifecycle. 846 Possible values are: 847 848 * `"Uncommitted"` --- The container request has not been finalized and can still be edited. 849 * `"Committed"` --- The container request is ready to be fulfilled. 850 * `"Final"` --- The container request has been fulfilled or cancelled. 851 """ 852 requesting_container_uuid: 'str' 853 """The UUID of the container that created this container request, if any.""" 854 container_uuid: 'str' 855 """The UUID of the container that fulfills this container request, if any.""" 856 container_count_max: 'int' 857 """An integer that defines the maximum number of times Arvados should attempt 858 to dispatch a container to fulfill this container request. 859 """ 860 mounts: 'Dict[str, Any]' 861 """A hash where each key names a directory inside this container, and its 862 value is an object that defines the mount source for that directory. Refer 863 to the [mount types reference][] for details. 864 865 [mount types reference]: https://doc.arvados.org/api/methods/containers.html#mount_types 866 """ 867 runtime_constraints: 'Dict[str, Any]' 868 """A hash that identifies compute resources this container requires to run 869 successfully. See the [runtime constraints reference][] for details. 870 871 [runtime constraints reference]: https://doc.arvados.org/api/methods/containers.html#runtime_constraints 872 """ 873 container_image: 'str' 874 """The portable data hash of the Arvados collection that contains the image 875 to use for this container. 876 """ 877 environment: 'Dict[str, Any]' 878 """A hash of string keys and values that defines the environment variables 879 for the dispatcher to set when it executes this container. 880 """ 881 cwd: 'str' 882 """A string that the defines the working directory that the dispatcher should 883 use when it executes the command inside this container. 884 """ 885 command: 'List' 886 """An array of strings that defines the command that the dispatcher should 887 execute inside this container. 888 """ 889 output_path: 'str' 890 """A string that defines the file or directory path where the command 891 writes output that should be saved from this container. 892 """ 893 priority: 'int' 894 """An integer between 0 and 1000 (inclusive) that represents this container request's 895 scheduling priority. 0 represents a request to be cancelled. Higher 896 values represent higher priority. Refer to the [priority reference][] for details. 897 898 [priority reference]: https://doc.arvados.org/api/methods/container_requests.html#priority 899 """ 900 expires_at: 'str' 901 """The time after which this container request will no longer be fulfilled. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 902 filters: 'str' 903 """Filters that limit which existing containers are eligible to satisfy this 904 container request. This attribute is not implemented yet and should be null. 905 """ 906 container_count: 'int' 907 """An integer that records how many times Arvados has attempted to dispatch 908 a container to fulfill this container request. 909 """ 910 use_existing: 'bool' 911 """A boolean flag. If set, Arvados may choose to satisfy this container 912 request with an eligible container that already exists. Otherwise, Arvados will 913 satisfy this container request with a newer container, which will usually result 914 in the container running again. 915 """ 916 scheduling_parameters: 'Dict[str, Any]' 917 """A hash of scheduling parameters that should be passed to the underlying 918 dispatcher when this container is run. 919 See the [scheduling parameters reference][] for details. 920 921 [scheduling parameters reference]: https://doc.arvados.org/api/methods/containers.html#scheduling_parameters 922 """ 923 output_uuid: 'str' 924 """The UUID of the Arvados collection that contains output for all the 925 container(s) that were dispatched to fulfill this container request. 926 """ 927 log_uuid: 'str' 928 """The UUID of the Arvados collection that contains logs for all the 929 container(s) that were dispatched to fulfill this container request. 930 """ 931 output_name: 'str' 932 """The name to set on the output collection of this container request.""" 933 output_ttl: 'int' 934 """An integer in seconds. If greater than zero, when an output collection is 935 created for this container request, its `expires_at` attribute will be set this 936 far in the future. 937 """ 938 output_storage_classes: 'List' 939 """An array of strings identifying the storage class(es) that should be set 940 on the output collection of this container request. Storage classes are configured by 941 the cluster administrator. 942 """ 943 output_properties: 'Dict[str, Any]' 944 """A hash of arbitrary metadata to set on the output collection of this container request. 945 Some keys may be reserved by Arvados or defined by a configured vocabulary. 946 Refer to the [metadata properties reference][] for details. 947 948 [metadata properties reference]: https://doc.arvados.org/api/properties.html 949 """ 950 cumulative_cost: 'float' 951 """A float with the estimated cost of all cloud instances used to run 952 container(s) to fulfill this container request and their subrequests. 953 The value is `0` if cost estimation is not available on this cluster. 954 """ 955 output_glob: 'List' 956 """An array of strings of shell-style glob patterns that define which file(s) 957 and subdirectory(ies) under the `output_path` directory should be recorded in 958 the container's final output. Refer to the [glob patterns reference][] for details. 959 960 [glob patterns reference]: https://doc.arvados.org/api/methods/containers.html#glob_patterns 961 """ 962 service: 'bool' 963 """A boolean flag. If set, it informs the system that this request is for a long-running container 964 that functions as a system service or web app, rather than a once-through batch operation. 965 """ 966 published_ports: 'Dict[str, Any]' 967 """A hash where keys are numeric TCP ports on the container which expose HTTP services. Arvados 968 will proxy HTTP requests to these ports. Values are hashes with the following keys: 969 970 * `"access"` --- One of 'private' or 'public' indicating if an Arvados API token is required to access the endpoint. 971 * `"label"` --- A human readable label describing the service, for display in Workbench. 972 * `"initial_path"` --- The relative path that should be included when constructing the URL that will be presented to the user in Workbench. 973 """
Arvados container request
A container request represents a user’s request that Arvados do some compute work, along with full details about what work should be done. Arvados will attempt to fulfill the request by mapping it to a matching container record, running the work on demand if necessary.
This is the dictionary object that represents a single ContainerRequest in Arvados
and is returned by most ContainerRequests methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
created_at: str
The time this container request was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
modified_at: str
The time this container request was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
description: str
A longer HTML description of this container request assigned by a user.
Allowed HTML tags are a, b, blockquote, br, code,
del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr,
i, img, kbd, li, ol, p, pre,
s, section, span, strong, sub, sup, and ul.
properties: Dict[str, Any]
A hash of arbitrary metadata for this container request. Some keys may be reserved by Arvados or defined by a configured vocabulary. Refer to the metadata properties reference for details.
state: str
A string indicating where this container request is in its lifecycle. Possible values are:
"Uncommitted"— The container request has not been finalized and can still be edited."Committed"— The container request is ready to be fulfilled."Final"— The container request has been fulfilled or cancelled.
requesting_container_uuid: str
The UUID of the container that created this container request, if any.
container_count_max: int
An integer that defines the maximum number of times Arvados should attempt to dispatch a container to fulfill this container request.
mounts: Dict[str, Any]
A hash where each key names a directory inside this container, and its value is an object that defines the mount source for that directory. Refer to the mount types reference for details.
runtime_constraints: Dict[str, Any]
A hash that identifies compute resources this container requires to run successfully. See the runtime constraints reference for details.
container_image: str
The portable data hash of the Arvados collection that contains the image to use for this container.
environment: Dict[str, Any]
A hash of string keys and values that defines the environment variables for the dispatcher to set when it executes this container.
cwd: str
A string that the defines the working directory that the dispatcher should use when it executes the command inside this container.
command: List
An array of strings that defines the command that the dispatcher should execute inside this container.
output_path: str
A string that defines the file or directory path where the command writes output that should be saved from this container.
priority: int
An integer between 0 and 1000 (inclusive) that represents this container request’s scheduling priority. 0 represents a request to be cancelled. Higher values represent higher priority. Refer to the priority reference for details.
expires_at: str
The time after which this container request will no longer be fulfilled. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
filters: str
Filters that limit which existing containers are eligible to satisfy this container request. This attribute is not implemented yet and should be null.
container_count: int
An integer that records how many times Arvados has attempted to dispatch a container to fulfill this container request.
use_existing: bool
A boolean flag. If set, Arvados may choose to satisfy this container request with an eligible container that already exists. Otherwise, Arvados will satisfy this container request with a newer container, which will usually result in the container running again.
scheduling_parameters: Dict[str, Any]
A hash of scheduling parameters that should be passed to the underlying dispatcher when this container is run. See the scheduling parameters reference for details.
output_uuid: str
The UUID of the Arvados collection that contains output for all the container(s) that were dispatched to fulfill this container request.
log_uuid: str
The UUID of the Arvados collection that contains logs for all the container(s) that were dispatched to fulfill this container request.
output_ttl: int
An integer in seconds. If greater than zero, when an output collection is
created for this container request, its expires_at attribute will be set this
far in the future.
output_storage_classes: List
An array of strings identifying the storage class(es) that should be set on the output collection of this container request. Storage classes are configured by the cluster administrator.
output_properties: Dict[str, Any]
A hash of arbitrary metadata to set on the output collection of this container request. Some keys may be reserved by Arvados or defined by a configured vocabulary. Refer to the metadata properties reference for details.
cumulative_cost: float
A float with the estimated cost of all cloud instances used to run
container(s) to fulfill this container request and their subrequests.
The value is 0 if cost estimation is not available on this cluster.
output_glob: List
An array of strings of shell-style glob patterns that define which file(s)
and subdirectory(ies) under the output_path directory should be recorded in
the container’s final output. Refer to the glob patterns reference for details.
service: bool
A boolean flag. If set, it informs the system that this request is for a long-running container that functions as a system service or web app, rather than a once-through batch operation.
published_ports: Dict[str, Any]
A hash where keys are numeric TCP ports on the container which expose HTTP services. Arvados will proxy HTTP requests to these ports. Values are hashes with the following keys:
"access"— One of ‘private’ or ‘public’ indicating if an Arvados API token is required to access the endpoint."label"— A human readable label describing the service, for display in Workbench."initial_path"— The relative path that should be included when constructing the URL that will be presented to the user in Workbench.
class
ContainerRequestList(typing.TypedDict):
976class ContainerRequestList(TypedDict, total=False): 977 """A list of ContainerRequest objects. 978 979 This is the dictionary object returned when you call `ContainerRequests.list`. 980 If you just want to iterate all objects that match your search criteria, 981 consider using `arvados.util.keyset_list_all`. 982 If you work with this raw object, the keys of the dictionary are documented 983 below, along with their types. The `items` key maps to a list of matching 984 `ContainerRequest` objects. 985 """ 986 kind: 'str' = 'arvados#containerRequestList' 987 """Object type. Always arvados#containerRequestList.""" 988 etag: 'str' 989 """List cache version.""" 990 items: 'List[ContainerRequest]' 991 """An array of matching ContainerRequest objects."""
A list of ContainerRequest objects.
This is the dictionary object returned when you call ContainerRequests.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.keyset_list_all.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
ContainerRequest objects.
class
ContainerRequests:
994class ContainerRequests: 995 """Methods to query and manipulate Arvados container requests""" 996 997 def container_status(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]': 998 """Return scheduling details for a container request. 999 1000 Required parameters: 1001 1002 * uuid: str --- The UUID of the container request to query. 1003 """ 1004 1005 def create(self, *, body: "Dict[Literal['container_request'], ContainerRequest]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1006 """Create a new ContainerRequest. 1007 1008 Required parameters: 1009 1010 * body: Dict[Literal['container_request'], ContainerRequest] --- A dictionary with a single item `'container_request'`. 1011 Its value is a `ContainerRequest` dictionary defining the attributes to set. 1012 1013 Optional parameters: 1014 1015 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1016 1017 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 1018 1019 * select: Optional[List] --- An array of names of attributes to return in the response. 1020 """ 1021 1022 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]': 1023 """Delete an existing ContainerRequest. 1024 1025 Required parameters: 1026 1027 * uuid: str --- The UUID of the ContainerRequest to delete. 1028 """ 1029 1030 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1031 """Get a ContainerRequest record by UUID. 1032 1033 Required parameters: 1034 1035 * uuid: str --- The UUID of the ContainerRequest to return. 1036 1037 Optional parameters: 1038 1039 * include_trash: bool --- Show container request even if its owner project is trashed. Default `False`. 1040 1041 * select: Optional[List] --- An array of names of attributes to return in the response. 1042 """ 1043 1044 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[ContainerRequestList]': 1045 """Retrieve a ContainerRequestList. 1046 1047 This method returns a single page of `ContainerRequest` objects that match your search 1048 criteria. If you just want to iterate all objects that match your search 1049 criteria, consider using `arvados.util.keyset_list_all`. 1050 1051 Optional parameters: 1052 1053 * bypass_federation: bool --- If true, do not return results from other clusters in the 1054 federation, only the cluster that received the request. 1055 You must be an administrator to use this flag. Default `False`. 1056 1057 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1058 1059 * count: str --- A string to determine result counting behavior. Supported values are: 1060 1061 * `"exact"`: The response will include an `items_available` field that 1062 counts the number of objects that matched this search criteria, 1063 including ones not included in `items`. 1064 1065 * `"none"`: The response will not include an `items_avaliable` 1066 field. This improves performance by returning a result as soon as enough 1067 `items` have been loaded for this result. 1068 1069 Default `'exact'`. 1070 1071 * distinct: bool --- If this is true, and multiple objects have the same values 1072 for the attributes that you specify in the `select` parameter, then each unique 1073 set of values will only be returned once in the result set. Default `False`. 1074 1075 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1076 Refer to the [filters reference][] for more information about how to write filters. 1077 1078 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1079 1080 * include_trash: bool --- Include container requests whose owner project is trashed. Default `False`. 1081 1082 * limit: int --- The maximum number of objects to return in the result. 1083 Note that the API may return fewer results than this if your request hits other 1084 limits set by the administrator. Default `100`. 1085 1086 * offset: int --- Return matching objects starting from this index. 1087 Note that result indexes may change if objects are modified in between a series 1088 of list calls. Default `0`. 1089 1090 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1091 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1092 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1093 1094 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1095 1096 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1097 The keys of this object are attribute names. 1098 Each value is either a single matching value or an array of matching values for that attribute. 1099 The `filters` parameter is more flexible and preferred. 1100 """ 1101 1102 def update(self, *, body: "Dict[Literal['container_request'], ContainerRequest]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1103 """Update attributes of an existing ContainerRequest. 1104 1105 Required parameters: 1106 1107 * body: Dict[Literal['container_request'], ContainerRequest] --- A dictionary with a single item `'container_request'`. 1108 Its value is a `ContainerRequest` dictionary defining the attributes to set. 1109 1110 * uuid: str --- The UUID of the ContainerRequest to update. 1111 1112 Optional parameters: 1113 1114 * select: Optional[List] --- An array of names of attributes to return in the response. 1115 """
Methods to query and manipulate Arvados container requests
997 def container_status(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]': 998 """Return scheduling details for a container request. 999 1000 Required parameters: 1001 1002 * uuid: str --- The UUID of the container request to query. 1003 """
Return scheduling details for a container request.
Required parameters:
- uuid: str — The UUID of the container request to query.
def
create( self, *, body: Dict[Literal['container_request'], ContainerRequest], cluster_id: Optional[str] = None, ensure_unique_name: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[ContainerRequest]:
1005 def create(self, *, body: "Dict[Literal['container_request'], ContainerRequest]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1006 """Create a new ContainerRequest. 1007 1008 Required parameters: 1009 1010 * body: Dict[Literal['container_request'], ContainerRequest] --- A dictionary with a single item `'container_request'`. 1011 Its value is a `ContainerRequest` dictionary defining the attributes to set. 1012 1013 Optional parameters: 1014 1015 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1016 1017 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 1018 1019 * select: Optional[List] --- An array of names of attributes to return in the response. 1020 """
Create a new ContainerRequest.
Required parameters:
- body: Dict[Literal[’container_request’], ContainerRequest] — A dictionary with a single item
'container_request'. Its value is aContainerRequestdictionary defining the attributes to set.
Optional parameters:
cluster_id: Optional[str] — Cluster ID of a federated cluster where this object should be created.
ensure_unique_name: bool — If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
1022 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]': 1023 """Delete an existing ContainerRequest. 1024 1025 Required parameters: 1026 1027 * uuid: str --- The UUID of the ContainerRequest to delete. 1028 """
Delete an existing ContainerRequest.
Required parameters:
- uuid: str — The UUID of the ContainerRequest to delete.
def
get( self, *, uuid: str, include_trash: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[ContainerRequest]:
1030 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1031 """Get a ContainerRequest record by UUID. 1032 1033 Required parameters: 1034 1035 * uuid: str --- The UUID of the ContainerRequest to return. 1036 1037 Optional parameters: 1038 1039 * include_trash: bool --- Show container request even if its owner project is trashed. Default `False`. 1040 1041 * select: Optional[List] --- An array of names of attributes to return in the response. 1042 """
Get a ContainerRequest record by UUID.
Required parameters:
- uuid: str — The UUID of the ContainerRequest to return.
Optional parameters:
include_trash: bool — Show container request even if its owner project is trashed. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
def
list( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, include_trash: bool = False, limit: int = 100, offset: int = 0, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[ContainerRequestList]:
1044 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[ContainerRequestList]': 1045 """Retrieve a ContainerRequestList. 1046 1047 This method returns a single page of `ContainerRequest` objects that match your search 1048 criteria. If you just want to iterate all objects that match your search 1049 criteria, consider using `arvados.util.keyset_list_all`. 1050 1051 Optional parameters: 1052 1053 * bypass_federation: bool --- If true, do not return results from other clusters in the 1054 federation, only the cluster that received the request. 1055 You must be an administrator to use this flag. Default `False`. 1056 1057 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1058 1059 * count: str --- A string to determine result counting behavior. Supported values are: 1060 1061 * `"exact"`: The response will include an `items_available` field that 1062 counts the number of objects that matched this search criteria, 1063 including ones not included in `items`. 1064 1065 * `"none"`: The response will not include an `items_avaliable` 1066 field. This improves performance by returning a result as soon as enough 1067 `items` have been loaded for this result. 1068 1069 Default `'exact'`. 1070 1071 * distinct: bool --- If this is true, and multiple objects have the same values 1072 for the attributes that you specify in the `select` parameter, then each unique 1073 set of values will only be returned once in the result set. Default `False`. 1074 1075 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1076 Refer to the [filters reference][] for more information about how to write filters. 1077 1078 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1079 1080 * include_trash: bool --- Include container requests whose owner project is trashed. Default `False`. 1081 1082 * limit: int --- The maximum number of objects to return in the result. 1083 Note that the API may return fewer results than this if your request hits other 1084 limits set by the administrator. Default `100`. 1085 1086 * offset: int --- Return matching objects starting from this index. 1087 Note that result indexes may change if objects are modified in between a series 1088 of list calls. Default `0`. 1089 1090 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1091 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1092 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1093 1094 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1095 1096 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1097 The keys of this object are attribute names. 1098 Each value is either a single matching value or an array of matching values for that attribute. 1099 The `filters` parameter is more flexible and preferred. 1100 """
Retrieve a ContainerRequestList.
This method returns a single page of ContainerRequest objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.keyset_list_all.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
include_trash: bool — Include container requests whose owner project is trashed. Default
False.limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
def
update( self, *, body: Dict[Literal['container_request'], ContainerRequest], uuid: str, select: Optional[List] = None) -> ArvadosAPIRequest[ContainerRequest]:
1102 def update(self, *, body: "Dict[Literal['container_request'], ContainerRequest]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1103 """Update attributes of an existing ContainerRequest. 1104 1105 Required parameters: 1106 1107 * body: Dict[Literal['container_request'], ContainerRequest] --- A dictionary with a single item `'container_request'`. 1108 Its value is a `ContainerRequest` dictionary defining the attributes to set. 1109 1110 * uuid: str --- The UUID of the ContainerRequest to update. 1111 1112 Optional parameters: 1113 1114 * select: Optional[List] --- An array of names of attributes to return in the response. 1115 """
Update attributes of an existing ContainerRequest.
Required parameters:
body: Dict[Literal[’container_request’], ContainerRequest] — A dictionary with a single item
'container_request'. Its value is aContainerRequestdictionary defining the attributes to set.uuid: str — The UUID of the ContainerRequest to update.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
class
Container(typing.TypedDict):
1118class Container(TypedDict, total=False): 1119 """Arvados container record 1120 1121 A container represents compute work that has been or should be dispatched, 1122 along with its results. A container can satisfy one or more container requests. 1123 1124 This is the dictionary object that represents a single Container in Arvados 1125 and is returned by most `Containers` methods. 1126 The keys of the dictionary are documented below, along with their types. 1127 Not every key may appear in every dictionary returned by an API call. 1128 When a method doesn't return all the data, you can use its `select` parameter 1129 to list the specific keys you need. Refer to the API documentation for details. 1130 """ 1131 etag: 'str' 1132 """Object cache version.""" 1133 uuid: 'str' 1134 """This container's Arvados UUID, like `zzzzz-dz642-12345abcde67890`.""" 1135 owner_uuid: 'str' 1136 """The UUID of the user or group that owns this container.""" 1137 created_at: 'str' 1138 """The time this container was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1139 modified_at: 'str' 1140 """The time this container was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1141 modified_by_user_uuid: 'str' 1142 """The UUID of the user that last updated this container.""" 1143 state: 'str' 1144 """A string representing the container's current execution status. Possible 1145 values are: 1146 1147 * `"Queued"` --- This container has not been dispatched yet. 1148 * `"Locked"` --- A dispatcher has claimed this container in preparation to run it. 1149 * `"Running"` --- A dispatcher is running this container. 1150 * `"Cancelled"` --- Container execution has been cancelled by user request. 1151 * `"Complete"` --- A dispatcher ran this container to completion and recorded the results. 1152 """ 1153 started_at: 'str' 1154 """The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1155 finished_at: 'str' 1156 """The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1157 log: 'str' 1158 """The portable data hash of the Arvados collection that contains this 1159 container's logs. 1160 """ 1161 environment: 'Dict[str, Any]' 1162 """A hash of string keys and values that defines the environment variables 1163 for the dispatcher to set when it executes this container. 1164 """ 1165 cwd: 'str' 1166 """A string that the defines the working directory that the dispatcher should 1167 use when it executes the command inside this container. 1168 """ 1169 command: 'List' 1170 """An array of strings that defines the command that the dispatcher should 1171 execute inside this container. 1172 """ 1173 output_path: 'str' 1174 """A string that defines the file or directory path where the command 1175 writes output that should be saved from this container. 1176 """ 1177 mounts: 'Dict[str, Any]' 1178 """A hash where each key names a directory inside this container, and its 1179 value is an object that defines the mount source for that directory. Refer 1180 to the [mount types reference][] for details. 1181 1182 [mount types reference]: https://doc.arvados.org/api/methods/containers.html#mount_types 1183 """ 1184 runtime_constraints: 'Dict[str, Any]' 1185 """A hash that identifies compute resources this container requires to run 1186 successfully. See the [runtime constraints reference][] for details. 1187 1188 [runtime constraints reference]: https://doc.arvados.org/api/methods/containers.html#runtime_constraints 1189 """ 1190 output: 'str' 1191 """The portable data hash of the Arvados collection that contains this 1192 container's output file(s). 1193 """ 1194 container_image: 'str' 1195 """The portable data hash of the Arvados collection that contains the image 1196 to use for this container. 1197 """ 1198 progress: 'float' 1199 """A float between 0.0 and 1.0 (inclusive) that represents the container's 1200 execution progress. This attribute is not implemented yet. 1201 """ 1202 priority: 'int' 1203 """An integer between 0 and 1000 (inclusive) that represents this container's 1204 scheduling priority. 0 represents a request to be cancelled. Higher 1205 values represent higher priority. Refer to the [priority reference][] for details. 1206 1207 [priority reference]: https://doc.arvados.org/api/methods/container_requests.html#priority 1208 """ 1209 exit_code: 'int' 1210 """An integer that records the Unix exit code of the `command` from a 1211 finished container. 1212 """ 1213 auth_uuid: 'str' 1214 """The UUID of the Arvados API client authorization token that a dispatcher 1215 should use to set up this container. This token is automatically created by 1216 Arvados and this attribute automatically assigned unless a container is 1217 created with `runtime_token`. 1218 """ 1219 locked_by_uuid: 'str' 1220 """The UUID of the Arvados API client authorization token that successfully 1221 locked this container in preparation to execute it. 1222 """ 1223 scheduling_parameters: 'Dict[str, Any]' 1224 """A hash of scheduling parameters that should be passed to the underlying 1225 dispatcher when this container is run. 1226 See the [scheduling parameters reference][] for details. 1227 1228 [scheduling parameters reference]: https://doc.arvados.org/api/methods/containers.html#scheduling_parameters 1229 """ 1230 runtime_status: 'Dict[str, Any]' 1231 """A hash with status updates from a running container. 1232 Refer to the [runtime status reference][] for details. 1233 1234 [runtime status reference]: https://doc.arvados.org/api/methods/containers.html#runtime_status 1235 """ 1236 runtime_user_uuid: 'str' 1237 """The UUID of the Arvados user associated with the API client authorization 1238 token used to run this container. 1239 """ 1240 runtime_auth_scopes: 'List' 1241 """The `scopes` from the API client authorization token used to run this container.""" 1242 lock_count: 'int' 1243 """The number of times this container has been locked by a dispatcher. This 1244 may be greater than 1 if a dispatcher locks a container but then execution is 1245 interrupted for any reason. 1246 """ 1247 gateway_address: 'str' 1248 """A string with the address of the Arvados gateway server, in `HOST:PORT` 1249 format. This is for internal use only. 1250 """ 1251 interactive_session_started: 'bool' 1252 """This flag is set true if any user starts an interactive shell inside the 1253 running container. 1254 """ 1255 output_storage_classes: 'List' 1256 """An array of strings identifying the storage class(es) that should be set 1257 on the output collection of this container. Storage classes are configured by 1258 the cluster administrator. 1259 """ 1260 output_properties: 'Dict[str, Any]' 1261 """A hash of arbitrary metadata to set on the output collection of this container. 1262 Some keys may be reserved by Arvados or defined by a configured vocabulary. 1263 Refer to the [metadata properties reference][] for details. 1264 1265 [metadata properties reference]: https://doc.arvados.org/api/properties.html 1266 """ 1267 cost: 'float' 1268 """A float with the estimated cost of the cloud instance used to run this 1269 container. The value is `0` if cost estimation is not available on this cluster. 1270 """ 1271 subrequests_cost: 'float' 1272 """A float with the estimated cost of all cloud instances used to run this 1273 container and all its subrequests. The value is `0` if cost estimation is not 1274 available on this cluster. 1275 """ 1276 output_glob: 'List' 1277 """An array of strings of shell-style glob patterns that define which file(s) 1278 and subdirectory(ies) under the `output_path` directory should be recorded in 1279 the container's final output. Refer to the [glob patterns reference][] for details. 1280 1281 [glob patterns reference]: https://doc.arvados.org/api/methods/containers.html#glob_patterns 1282 """ 1283 service: 'bool' 1284 """A boolean flag. If set, it informs the system that this is a long-running container 1285 that functions as a system service or web app, rather than a once-through batch operation. 1286 """ 1287 published_ports: 'jsonb' 1288 """A hash where keys are numeric TCP ports on the container which expose HTTP services. Arvados 1289 will proxy HTTP requests to these ports. Values are hashes with the following keys: 1290 1291 * `"access"` --- One of 'private' or 'public' indicating if an Arvados API token is required to access the endpoint. 1292 * `"label"` --- A human readable label describing the service, for display in Workbench. 1293 * `"initial_path"` --- The relative path that should be included when constructing the URL that will be presented to the user in Workbench. 1294 """
Arvados container record
A container represents compute work that has been or should be dispatched, along with its results. A container can satisfy one or more container requests.
This is the dictionary object that represents a single Container in Arvados
and is returned by most Containers methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
created_at: str
The time this container was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
modified_at: str
The time this container was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
state: str
A string representing the container’s current execution status. Possible values are:
"Queued"— This container has not been dispatched yet."Locked"— A dispatcher has claimed this container in preparation to run it."Running"— A dispatcher is running this container."Cancelled"— Container execution has been cancelled by user request."Complete"— A dispatcher ran this container to completion and recorded the results.
started_at: str
The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
finished_at: str
The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
environment: Dict[str, Any]
A hash of string keys and values that defines the environment variables for the dispatcher to set when it executes this container.
cwd: str
A string that the defines the working directory that the dispatcher should use when it executes the command inside this container.
command: List
An array of strings that defines the command that the dispatcher should execute inside this container.
output_path: str
A string that defines the file or directory path where the command writes output that should be saved from this container.
mounts: Dict[str, Any]
A hash where each key names a directory inside this container, and its value is an object that defines the mount source for that directory. Refer to the mount types reference for details.
runtime_constraints: Dict[str, Any]
A hash that identifies compute resources this container requires to run successfully. See the runtime constraints reference for details.
output: str
The portable data hash of the Arvados collection that contains this container’s output file(s).
container_image: str
The portable data hash of the Arvados collection that contains the image to use for this container.
progress: float
A float between 0.0 and 1.0 (inclusive) that represents the container’s execution progress. This attribute is not implemented yet.
priority: int
An integer between 0 and 1000 (inclusive) that represents this container’s scheduling priority. 0 represents a request to be cancelled. Higher values represent higher priority. Refer to the priority reference for details.
auth_uuid: str
The UUID of the Arvados API client authorization token that a dispatcher
should use to set up this container. This token is automatically created by
Arvados and this attribute automatically assigned unless a container is
created with runtime_token.
locked_by_uuid: str
The UUID of the Arvados API client authorization token that successfully locked this container in preparation to execute it.
scheduling_parameters: Dict[str, Any]
A hash of scheduling parameters that should be passed to the underlying dispatcher when this container is run. See the scheduling parameters reference for details.
runtime_status: Dict[str, Any]
A hash with status updates from a running container. Refer to the runtime status reference for details.
runtime_user_uuid: str
The UUID of the Arvados user associated with the API client authorization token used to run this container.
runtime_auth_scopes: List
The scopes from the API client authorization token used to run this container.
lock_count: int
The number of times this container has been locked by a dispatcher. This may be greater than 1 if a dispatcher locks a container but then execution is interrupted for any reason.
gateway_address: str
A string with the address of the Arvados gateway server, in HOST:PORT
format. This is for internal use only.
interactive_session_started: bool
This flag is set true if any user starts an interactive shell inside the running container.
output_storage_classes: List
An array of strings identifying the storage class(es) that should be set on the output collection of this container. Storage classes are configured by the cluster administrator.
output_properties: Dict[str, Any]
A hash of arbitrary metadata to set on the output collection of this container. Some keys may be reserved by Arvados or defined by a configured vocabulary. Refer to the metadata properties reference for details.
cost: float
A float with the estimated cost of the cloud instance used to run this
container. The value is 0 if cost estimation is not available on this cluster.
subrequests_cost: float
A float with the estimated cost of all cloud instances used to run this
container and all its subrequests. The value is 0 if cost estimation is not
available on this cluster.
output_glob: List
An array of strings of shell-style glob patterns that define which file(s)
and subdirectory(ies) under the output_path directory should be recorded in
the container’s final output. Refer to the glob patterns reference for details.
service: bool
A boolean flag. If set, it informs the system that this is a long-running container that functions as a system service or web app, rather than a once-through batch operation.
published_ports: ForwardRef('jsonb')
A hash where keys are numeric TCP ports on the container which expose HTTP services. Arvados will proxy HTTP requests to these ports. Values are hashes with the following keys:
"access"— One of ‘private’ or ‘public’ indicating if an Arvados API token is required to access the endpoint."label"— A human readable label describing the service, for display in Workbench."initial_path"— The relative path that should be included when constructing the URL that will be presented to the user in Workbench.
class
ContainerList(typing.TypedDict):
1297class ContainerList(TypedDict, total=False): 1298 """A list of Container objects. 1299 1300 This is the dictionary object returned when you call `Containers.list`. 1301 If you just want to iterate all objects that match your search criteria, 1302 consider using `arvados.util.keyset_list_all`. 1303 If you work with this raw object, the keys of the dictionary are documented 1304 below, along with their types. The `items` key maps to a list of matching 1305 `Container` objects. 1306 """ 1307 kind: 'str' = 'arvados#containerList' 1308 """Object type. Always arvados#containerList.""" 1309 etag: 'str' 1310 """List cache version.""" 1311 items: 'List[Container]' 1312 """An array of matching Container objects."""
A list of Container objects.
This is the dictionary object returned when you call Containers.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.keyset_list_all.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
Container objects.
class
Containers:
1315class Containers: 1316 """Methods to query and manipulate Arvados containers""" 1317 1318 def auth(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1319 """Get the API client authorization token associated with this container. 1320 1321 Required parameters: 1322 1323 * uuid: str --- The UUID of the Container to query. 1324 """ 1325 1326 def create(self, *, body: "Dict[Literal['container'], Container]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1327 """Create a new Container. 1328 1329 Required parameters: 1330 1331 * body: Dict[Literal['container'], Container] --- A dictionary with a single item `'container'`. 1332 Its value is a `Container` dictionary defining the attributes to set. 1333 1334 Optional parameters: 1335 1336 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1337 1338 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 1339 1340 * select: Optional[List] --- An array of names of attributes to return in the response. 1341 """ 1342 1343 def current(self) -> 'ArvadosAPIRequest[Container]': 1344 """Return the container record associated with the API token authorizing this request.""" 1345 1346 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1347 """Delete an existing Container. 1348 1349 Required parameters: 1350 1351 * uuid: str --- The UUID of the Container to delete. 1352 """ 1353 1354 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1355 """Get a Container record by UUID. 1356 1357 Required parameters: 1358 1359 * uuid: str --- The UUID of the Container to return. 1360 1361 Optional parameters: 1362 1363 * select: Optional[List] --- An array of names of attributes to return in the response. 1364 """ 1365 1366 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[ContainerList]': 1367 """Retrieve a ContainerList. 1368 1369 This method returns a single page of `Container` objects that match your search 1370 criteria. If you just want to iterate all objects that match your search 1371 criteria, consider using `arvados.util.keyset_list_all`. 1372 1373 Optional parameters: 1374 1375 * bypass_federation: bool --- If true, do not return results from other clusters in the 1376 federation, only the cluster that received the request. 1377 You must be an administrator to use this flag. Default `False`. 1378 1379 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1380 1381 * count: str --- A string to determine result counting behavior. Supported values are: 1382 1383 * `"exact"`: The response will include an `items_available` field that 1384 counts the number of objects that matched this search criteria, 1385 including ones not included in `items`. 1386 1387 * `"none"`: The response will not include an `items_avaliable` 1388 field. This improves performance by returning a result as soon as enough 1389 `items` have been loaded for this result. 1390 1391 Default `'exact'`. 1392 1393 * distinct: bool --- If this is true, and multiple objects have the same values 1394 for the attributes that you specify in the `select` parameter, then each unique 1395 set of values will only be returned once in the result set. Default `False`. 1396 1397 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1398 Refer to the [filters reference][] for more information about how to write filters. 1399 1400 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1401 1402 * limit: int --- The maximum number of objects to return in the result. 1403 Note that the API may return fewer results than this if your request hits other 1404 limits set by the administrator. Default `100`. 1405 1406 * offset: int --- Return matching objects starting from this index. 1407 Note that result indexes may change if objects are modified in between a series 1408 of list calls. Default `0`. 1409 1410 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1411 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1412 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1413 1414 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1415 1416 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1417 The keys of this object are attribute names. 1418 Each value is either a single matching value or an array of matching values for that attribute. 1419 The `filters` parameter is more flexible and preferred. 1420 """ 1421 1422 def lock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1423 """Lock a container (for a dispatcher to begin running it). 1424 1425 Required parameters: 1426 1427 * uuid: str --- The UUID of the Container to update. 1428 """ 1429 1430 def secret_mounts(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1431 """Return secret mount information for the container associated with the API token authorizing this request. 1432 1433 Required parameters: 1434 1435 * uuid: str --- The UUID of the Container to query. 1436 """ 1437 1438 def unlock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1439 """Unlock a container (for a dispatcher to stop running it). 1440 1441 Required parameters: 1442 1443 * uuid: str --- The UUID of the Container to update. 1444 """ 1445 1446 def update(self, *, body: "Dict[Literal['container'], Container]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1447 """Update attributes of an existing Container. 1448 1449 Required parameters: 1450 1451 * body: Dict[Literal['container'], Container] --- A dictionary with a single item `'container'`. 1452 Its value is a `Container` dictionary defining the attributes to set. 1453 1454 * uuid: str --- The UUID of the Container to update. 1455 1456 Optional parameters: 1457 1458 * select: Optional[List] --- An array of names of attributes to return in the response. 1459 """ 1460 1461 def update_priority(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1462 """Recalculate and return the priority of a given container. 1463 1464 Required parameters: 1465 1466 * uuid: str --- The UUID of the Container to update. 1467 """
Methods to query and manipulate Arvados containers
1318 def auth(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1319 """Get the API client authorization token associated with this container. 1320 1321 Required parameters: 1322 1323 * uuid: str --- The UUID of the Container to query. 1324 """
Get the API client authorization token associated with this container.
Required parameters:
- uuid: str — The UUID of the Container to query.
def
create( self, *, body: Dict[Literal['container'], Container], cluster_id: Optional[str] = None, ensure_unique_name: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[Container]:
1326 def create(self, *, body: "Dict[Literal['container'], Container]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1327 """Create a new Container. 1328 1329 Required parameters: 1330 1331 * body: Dict[Literal['container'], Container] --- A dictionary with a single item `'container'`. 1332 Its value is a `Container` dictionary defining the attributes to set. 1333 1334 Optional parameters: 1335 1336 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1337 1338 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 1339 1340 * select: Optional[List] --- An array of names of attributes to return in the response. 1341 """
Create a new Container.
Required parameters:
- body: Dict[Literal[’container’], Container] — A dictionary with a single item
'container'. Its value is aContainerdictionary defining the attributes to set.
Optional parameters:
cluster_id: Optional[str] — Cluster ID of a federated cluster where this object should be created.
ensure_unique_name: bool — If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
1343 def current(self) -> 'ArvadosAPIRequest[Container]': 1344 """Return the container record associated with the API token authorizing this request."""
Return the container record associated with the API token authorizing this request.
1346 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1347 """Delete an existing Container. 1348 1349 Required parameters: 1350 1351 * uuid: str --- The UUID of the Container to delete. 1352 """
Delete an existing Container.
Required parameters:
- uuid: str — The UUID of the Container to delete.
1354 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1355 """Get a Container record by UUID. 1356 1357 Required parameters: 1358 1359 * uuid: str --- The UUID of the Container to return. 1360 1361 Optional parameters: 1362 1363 * select: Optional[List] --- An array of names of attributes to return in the response. 1364 """
Get a Container record by UUID.
Required parameters:
- uuid: str — The UUID of the Container to return.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
def
list( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, limit: int = 100, offset: int = 0, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[ContainerList]:
1366 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[ContainerList]': 1367 """Retrieve a ContainerList. 1368 1369 This method returns a single page of `Container` objects that match your search 1370 criteria. If you just want to iterate all objects that match your search 1371 criteria, consider using `arvados.util.keyset_list_all`. 1372 1373 Optional parameters: 1374 1375 * bypass_federation: bool --- If true, do not return results from other clusters in the 1376 federation, only the cluster that received the request. 1377 You must be an administrator to use this flag. Default `False`. 1378 1379 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1380 1381 * count: str --- A string to determine result counting behavior. Supported values are: 1382 1383 * `"exact"`: The response will include an `items_available` field that 1384 counts the number of objects that matched this search criteria, 1385 including ones not included in `items`. 1386 1387 * `"none"`: The response will not include an `items_avaliable` 1388 field. This improves performance by returning a result as soon as enough 1389 `items` have been loaded for this result. 1390 1391 Default `'exact'`. 1392 1393 * distinct: bool --- If this is true, and multiple objects have the same values 1394 for the attributes that you specify in the `select` parameter, then each unique 1395 set of values will only be returned once in the result set. Default `False`. 1396 1397 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1398 Refer to the [filters reference][] for more information about how to write filters. 1399 1400 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1401 1402 * limit: int --- The maximum number of objects to return in the result. 1403 Note that the API may return fewer results than this if your request hits other 1404 limits set by the administrator. Default `100`. 1405 1406 * offset: int --- Return matching objects starting from this index. 1407 Note that result indexes may change if objects are modified in between a series 1408 of list calls. Default `0`. 1409 1410 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1411 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1412 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1413 1414 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1415 1416 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1417 The keys of this object are attribute names. 1418 Each value is either a single matching value or an array of matching values for that attribute. 1419 The `filters` parameter is more flexible and preferred. 1420 """
Retrieve a ContainerList.
This method returns a single page of Container objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.keyset_list_all.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
1422 def lock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1423 """Lock a container (for a dispatcher to begin running it). 1424 1425 Required parameters: 1426 1427 * uuid: str --- The UUID of the Container to update. 1428 """
Lock a container (for a dispatcher to begin running it).
Required parameters:
- uuid: str — The UUID of the Container to update.
1430 def secret_mounts(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1431 """Return secret mount information for the container associated with the API token authorizing this request. 1432 1433 Required parameters: 1434 1435 * uuid: str --- The UUID of the Container to query. 1436 """
Return secret mount information for the container associated with the API token authorizing this request.
Required parameters:
- uuid: str — The UUID of the Container to query.
1438 def unlock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1439 """Unlock a container (for a dispatcher to stop running it). 1440 1441 Required parameters: 1442 1443 * uuid: str --- The UUID of the Container to update. 1444 """
Unlock a container (for a dispatcher to stop running it).
Required parameters:
- uuid: str — The UUID of the Container to update.
def
update( self, *, body: Dict[Literal['container'], Container], uuid: str, select: Optional[List] = None) -> ArvadosAPIRequest[Container]:
1446 def update(self, *, body: "Dict[Literal['container'], Container]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1447 """Update attributes of an existing Container. 1448 1449 Required parameters: 1450 1451 * body: Dict[Literal['container'], Container] --- A dictionary with a single item `'container'`. 1452 Its value is a `Container` dictionary defining the attributes to set. 1453 1454 * uuid: str --- The UUID of the Container to update. 1455 1456 Optional parameters: 1457 1458 * select: Optional[List] --- An array of names of attributes to return in the response. 1459 """
Update attributes of an existing Container.
Required parameters:
body: Dict[Literal[’container’], Container] — A dictionary with a single item
'container'. Its value is aContainerdictionary defining the attributes to set.uuid: str — The UUID of the Container to update.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
1461 def update_priority(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1462 """Recalculate and return the priority of a given container. 1463 1464 Required parameters: 1465 1466 * uuid: str --- The UUID of the Container to update. 1467 """
Recalculate and return the priority of a given container.
Required parameters:
- uuid: str — The UUID of the Container to update.
class
Group(typing.TypedDict):
1470class Group(TypedDict, total=False): 1471 """Arvados group 1472 1473 Groups provide a way to organize users or data together, depending on their 1474 `group_class`. 1475 1476 This is the dictionary object that represents a single Group in Arvados 1477 and is returned by most `Groups` methods. 1478 The keys of the dictionary are documented below, along with their types. 1479 Not every key may appear in every dictionary returned by an API call. 1480 When a method doesn't return all the data, you can use its `select` parameter 1481 to list the specific keys you need. Refer to the API documentation for details. 1482 """ 1483 etag: 'str' 1484 """Object cache version.""" 1485 uuid: 'str' 1486 """This group's Arvados UUID, like `zzzzz-j7d0g-12345abcde67890`.""" 1487 owner_uuid: 'str' 1488 """The UUID of the user or group that owns this group.""" 1489 created_at: 'str' 1490 """The time this group was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1491 modified_by_user_uuid: 'str' 1492 """The UUID of the user that last updated this group.""" 1493 modified_at: 'str' 1494 """The time this group was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1495 name: 'str' 1496 """The name of this group assigned by a user.""" 1497 description: 'str' 1498 """A longer HTML description of this group assigned by a user. 1499 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 1500 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 1501 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 1502 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 1503 """ 1504 group_class: 'str' 1505 """A string representing which type of group this is. One of: 1506 1507 * `"filter"` --- A virtual project whose contents are selected dynamically by filters. 1508 * `"project"` --- An Arvados project that can contain collections, 1509 container records, workflows, and subprojects. 1510 * `"role"` --- A group of users that can be granted permissions in Arvados. 1511 """ 1512 trash_at: 'str' 1513 """The time this group will be trashed. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1514 is_trashed: 'bool' 1515 """A boolean flag to indicate whether or not this group is trashed.""" 1516 delete_at: 'str' 1517 """The time this group will be permanently deleted. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1518 properties: 'Dict[str, Any]' 1519 """A hash of arbitrary metadata for this group. 1520 Some keys may be reserved by Arvados or defined by a configured vocabulary. 1521 Refer to the [metadata properties reference][] for details. 1522 1523 [metadata properties reference]: https://doc.arvados.org/api/properties.html 1524 """ 1525 frozen_by_uuid: 'str' 1526 """The UUID of the user that has frozen this group, if any. Frozen projects 1527 cannot have their contents or metadata changed, even by admins. 1528 """
Arvados group
Groups provide a way to organize users or data together, depending on their
group_class.
This is the dictionary object that represents a single Group in Arvados
and is returned by most Groups methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
created_at: str
The time this group was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
modified_at: str
The time this group was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
description: str
A longer HTML description of this group assigned by a user.
Allowed HTML tags are a, b, blockquote, br, code,
del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr,
i, img, kbd, li, ol, p, pre,
s, section, span, strong, sub, sup, and ul.
group_class: str
A string representing which type of group this is. One of:
"filter"— A virtual project whose contents are selected dynamically by filters."project"— An Arvados project that can contain collections, container records, workflows, and subprojects."role"— A group of users that can be granted permissions in Arvados.
trash_at: str
The time this group will be trashed. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
delete_at: str
The time this group will be permanently deleted. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
properties: Dict[str, Any]
A hash of arbitrary metadata for this group. Some keys may be reserved by Arvados or defined by a configured vocabulary. Refer to the metadata properties reference for details.
class
GroupList(typing.TypedDict):
1531class GroupList(TypedDict, total=False): 1532 """A list of Group objects. 1533 1534 This is the dictionary object returned when you call `Groups.list`. 1535 If you just want to iterate all objects that match your search criteria, 1536 consider using `arvados.util.keyset_list_all`. 1537 If you work with this raw object, the keys of the dictionary are documented 1538 below, along with their types. The `items` key maps to a list of matching 1539 `Group` objects. 1540 """ 1541 kind: 'str' = 'arvados#groupList' 1542 """Object type. Always arvados#groupList.""" 1543 etag: 'str' 1544 """List cache version.""" 1545 items: 'List[Group]' 1546 """An array of matching Group objects."""
A list of Group objects.
This is the dictionary object returned when you call Groups.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.keyset_list_all.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
Group objects.
class
Groups:
1549class Groups: 1550 """Methods to query and manipulate Arvados groups""" 1551 1552 def contents(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, exclude_home_project: 'bool' = False, filters: 'Optional[List]' = None, include: 'Optional[List]' = None, include_old_versions: 'bool' = False, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, recursive: 'bool' = False, select: 'Optional[List]' = None, uuid: 'str' = '', where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[Group]': 1553 """List objects that belong to a group. 1554 1555 Optional parameters: 1556 1557 * bypass_federation: bool --- If true, do not return results from other clusters in the 1558 federation, only the cluster that received the request. 1559 You must be an administrator to use this flag. Default `False`. 1560 1561 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1562 1563 * count: str --- A string to determine result counting behavior. Supported values are: 1564 1565 * `"exact"`: The response will include an `items_available` field that 1566 counts the number of objects that matched this search criteria, 1567 including ones not included in `items`. 1568 1569 * `"none"`: The response will not include an `items_avaliable` 1570 field. This improves performance by returning a result as soon as enough 1571 `items` have been loaded for this result. 1572 1573 Default `'exact'`. 1574 1575 * distinct: bool --- If this is true, and multiple objects have the same values 1576 for the attributes that you specify in the `select` parameter, then each unique 1577 set of values will only be returned once in the result set. Default `False`. 1578 1579 * exclude_home_project: bool --- If true, exclude contents of the user's home project from the listing. 1580 Calling this method with this flag set is how clients enumerate objects shared 1581 with the current user. Default `False`. 1582 1583 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1584 Refer to the [filters reference][] for more information about how to write filters. 1585 1586 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1587 1588 * include: Optional[List] --- An array of referenced objects to include in the `included` field of the response. Supported values in the array are: 1589 1590 * `"container_uuid"` 1591 * `"owner_uuid"` 1592 1593 1594 1595 * include_old_versions: bool --- If true, include past versions of collections in the listing. Default `False`. 1596 1597 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1598 1599 * limit: int --- The maximum number of objects to return in the result. 1600 Note that the API may return fewer results than this if your request hits other 1601 limits set by the administrator. Default `100`. 1602 1603 * offset: int --- Return matching objects starting from this index. 1604 Note that result indexes may change if objects are modified in between a series 1605 of list calls. Default `0`. 1606 1607 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1608 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1609 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1610 1611 * recursive: bool --- If true, include contents from child groups recursively. Default `False`. 1612 1613 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1614 1615 * uuid: str --- If given, limit the listing to objects owned by the 1616 user or group with this UUID. Default `''`. 1617 1618 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1619 The keys of this object are attribute names. 1620 Each value is either a single matching value or an array of matching values for that attribute. 1621 The `filters` parameter is more flexible and preferred. 1622 """ 1623 1624 def create(self, *, body: "Dict[Literal['group'], Group]", async_: 'bool' = False, cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1625 """Create a new Group. 1626 1627 Required parameters: 1628 1629 * body: Dict[Literal['group'], Group] --- A dictionary with a single item `'group'`. 1630 Its value is a `Group` dictionary defining the attributes to set. 1631 1632 Optional parameters: 1633 1634 * async: bool --- If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default `False`. 1635 1636 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1637 1638 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 1639 1640 * select: Optional[List] --- An array of names of attributes to return in the response. 1641 """ 1642 1643 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1644 """Delete an existing Group. 1645 1646 Required parameters: 1647 1648 * uuid: str --- The UUID of the Group to delete. 1649 """ 1650 1651 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1652 """Get a Group record by UUID. 1653 1654 Required parameters: 1655 1656 * uuid: str --- The UUID of the Group to return. 1657 1658 Optional parameters: 1659 1660 * include_trash: bool --- Return group/project even if its `is_trashed` attribute is true. Default `False`. 1661 1662 * select: Optional[List] --- An array of names of attributes to return in the response. 1663 """ 1664 1665 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[GroupList]': 1666 """Retrieve a GroupList. 1667 1668 This method returns a single page of `Group` objects that match your search 1669 criteria. If you just want to iterate all objects that match your search 1670 criteria, consider using `arvados.util.keyset_list_all`. 1671 1672 Optional parameters: 1673 1674 * bypass_federation: bool --- If true, do not return results from other clusters in the 1675 federation, only the cluster that received the request. 1676 You must be an administrator to use this flag. Default `False`. 1677 1678 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1679 1680 * count: str --- A string to determine result counting behavior. Supported values are: 1681 1682 * `"exact"`: The response will include an `items_available` field that 1683 counts the number of objects that matched this search criteria, 1684 including ones not included in `items`. 1685 1686 * `"none"`: The response will not include an `items_avaliable` 1687 field. This improves performance by returning a result as soon as enough 1688 `items` have been loaded for this result. 1689 1690 Default `'exact'`. 1691 1692 * distinct: bool --- If this is true, and multiple objects have the same values 1693 for the attributes that you specify in the `select` parameter, then each unique 1694 set of values will only be returned once in the result set. Default `False`. 1695 1696 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1697 Refer to the [filters reference][] for more information about how to write filters. 1698 1699 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1700 1701 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1702 1703 * limit: int --- The maximum number of objects to return in the result. 1704 Note that the API may return fewer results than this if your request hits other 1705 limits set by the administrator. Default `100`. 1706 1707 * offset: int --- Return matching objects starting from this index. 1708 Note that result indexes may change if objects are modified in between a series 1709 of list calls. Default `0`. 1710 1711 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1712 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1713 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1714 1715 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1716 1717 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1718 The keys of this object are attribute names. 1719 Each value is either a single matching value or an array of matching values for that attribute. 1720 The `filters` parameter is more flexible and preferred. 1721 """ 1722 1723 def shared(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, include: 'Optional[str]' = None, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[Group]': 1724 """List groups that the current user can access via permission links. 1725 1726 Optional parameters: 1727 1728 * bypass_federation: bool --- If true, do not return results from other clusters in the 1729 federation, only the cluster that received the request. 1730 You must be an administrator to use this flag. Default `False`. 1731 1732 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1733 1734 * count: str --- A string to determine result counting behavior. Supported values are: 1735 1736 * `"exact"`: The response will include an `items_available` field that 1737 counts the number of objects that matched this search criteria, 1738 including ones not included in `items`. 1739 1740 * `"none"`: The response will not include an `items_avaliable` 1741 field. This improves performance by returning a result as soon as enough 1742 `items` have been loaded for this result. 1743 1744 Default `'exact'`. 1745 1746 * distinct: bool --- If this is true, and multiple objects have the same values 1747 for the attributes that you specify in the `select` parameter, then each unique 1748 set of values will only be returned once in the result set. Default `False`. 1749 1750 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1751 Refer to the [filters reference][] for more information about how to write filters. 1752 1753 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1754 1755 * include: Optional[str] --- A string naming referenced objects to include in the `included` field of the response. Supported values are: 1756 1757 * `"owner_uuid"` 1758 1759 1760 1761 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1762 1763 * limit: int --- The maximum number of objects to return in the result. 1764 Note that the API may return fewer results than this if your request hits other 1765 limits set by the administrator. Default `100`. 1766 1767 * offset: int --- Return matching objects starting from this index. 1768 Note that result indexes may change if objects are modified in between a series 1769 of list calls. Default `0`. 1770 1771 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1772 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1773 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1774 1775 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1776 1777 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1778 The keys of this object are attribute names. 1779 Each value is either a single matching value or an array of matching values for that attribute. 1780 The `filters` parameter is more flexible and preferred. 1781 """ 1782 1783 def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1784 """Trash a group. 1785 1786 Required parameters: 1787 1788 * uuid: str --- The UUID of the Group to update. 1789 """ 1790 1791 def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1792 """Untrash a group. 1793 1794 Required parameters: 1795 1796 * uuid: str --- The UUID of the Group to update. 1797 """ 1798 1799 def update(self, *, body: "Dict[Literal['group'], Group]", uuid: 'str', async_: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1800 """Update attributes of an existing Group. 1801 1802 Required parameters: 1803 1804 * body: Dict[Literal['group'], Group] --- A dictionary with a single item `'group'`. 1805 Its value is a `Group` dictionary defining the attributes to set. 1806 1807 * uuid: str --- The UUID of the Group to update. 1808 1809 Optional parameters: 1810 1811 * async: bool --- If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default `False`. 1812 1813 * select: Optional[List] --- An array of names of attributes to return in the response. 1814 """
Methods to query and manipulate Arvados groups
def
contents( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, exclude_home_project: bool = False, filters: Optional[List] = None, include: Optional[List] = None, include_old_versions: bool = False, include_trash: bool = False, limit: int = 100, offset: int = 0, order: Optional[List] = None, recursive: bool = False, select: Optional[List] = None, uuid: str = '', where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[Group]:
1552 def contents(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, exclude_home_project: 'bool' = False, filters: 'Optional[List]' = None, include: 'Optional[List]' = None, include_old_versions: 'bool' = False, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, recursive: 'bool' = False, select: 'Optional[List]' = None, uuid: 'str' = '', where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[Group]': 1553 """List objects that belong to a group. 1554 1555 Optional parameters: 1556 1557 * bypass_federation: bool --- If true, do not return results from other clusters in the 1558 federation, only the cluster that received the request. 1559 You must be an administrator to use this flag. Default `False`. 1560 1561 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1562 1563 * count: str --- A string to determine result counting behavior. Supported values are: 1564 1565 * `"exact"`: The response will include an `items_available` field that 1566 counts the number of objects that matched this search criteria, 1567 including ones not included in `items`. 1568 1569 * `"none"`: The response will not include an `items_avaliable` 1570 field. This improves performance by returning a result as soon as enough 1571 `items` have been loaded for this result. 1572 1573 Default `'exact'`. 1574 1575 * distinct: bool --- If this is true, and multiple objects have the same values 1576 for the attributes that you specify in the `select` parameter, then each unique 1577 set of values will only be returned once in the result set. Default `False`. 1578 1579 * exclude_home_project: bool --- If true, exclude contents of the user's home project from the listing. 1580 Calling this method with this flag set is how clients enumerate objects shared 1581 with the current user. Default `False`. 1582 1583 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1584 Refer to the [filters reference][] for more information about how to write filters. 1585 1586 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1587 1588 * include: Optional[List] --- An array of referenced objects to include in the `included` field of the response. Supported values in the array are: 1589 1590 * `"container_uuid"` 1591 * `"owner_uuid"` 1592 1593 1594 1595 * include_old_versions: bool --- If true, include past versions of collections in the listing. Default `False`. 1596 1597 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1598 1599 * limit: int --- The maximum number of objects to return in the result. 1600 Note that the API may return fewer results than this if your request hits other 1601 limits set by the administrator. Default `100`. 1602 1603 * offset: int --- Return matching objects starting from this index. 1604 Note that result indexes may change if objects are modified in between a series 1605 of list calls. Default `0`. 1606 1607 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1608 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1609 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1610 1611 * recursive: bool --- If true, include contents from child groups recursively. Default `False`. 1612 1613 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1614 1615 * uuid: str --- If given, limit the listing to objects owned by the 1616 user or group with this UUID. Default `''`. 1617 1618 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1619 The keys of this object are attribute names. 1620 Each value is either a single matching value or an array of matching values for that attribute. 1621 The `filters` parameter is more flexible and preferred. 1622 """
List objects that belong to a group.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.exclude_home_project: bool — If true, exclude contents of the user’s home project from the listing. Calling this method with this flag set is how clients enumerate objects shared with the current user. Default
False.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
include: Optional[List] — An array of referenced objects to include in the
includedfield of the response. Supported values in the array are:"container_uuid""owner_uuid"
include_old_versions: bool — If true, include past versions of collections in the listing. Default
False.include_trash: bool — Include items whose
is_trashedattribute is true. DefaultFalse.limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.recursive: bool — If true, include contents from child groups recursively. Default
False.select: Optional[List] — An array of names of attributes to return from each matching object.
uuid: str — If given, limit the listing to objects owned by the user or group with this UUID. Default
''.where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
def
create( self, *, body: Dict[Literal['group'], Group], async_: bool = False, cluster_id: Optional[str] = None, ensure_unique_name: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[Group]:
1624 def create(self, *, body: "Dict[Literal['group'], Group]", async_: 'bool' = False, cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1625 """Create a new Group. 1626 1627 Required parameters: 1628 1629 * body: Dict[Literal['group'], Group] --- A dictionary with a single item `'group'`. 1630 Its value is a `Group` dictionary defining the attributes to set. 1631 1632 Optional parameters: 1633 1634 * async: bool --- If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default `False`. 1635 1636 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1637 1638 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 1639 1640 * select: Optional[List] --- An array of names of attributes to return in the response. 1641 """
Create a new Group.
Required parameters:
- body: Dict[Literal[’group’], Group] — A dictionary with a single item
'group'. Its value is aGroupdictionary defining the attributes to set.
Optional parameters:
async: bool — If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster where this object should be created.
ensure_unique_name: bool — If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
1643 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1644 """Delete an existing Group. 1645 1646 Required parameters: 1647 1648 * uuid: str --- The UUID of the Group to delete. 1649 """
Delete an existing Group.
Required parameters:
- uuid: str — The UUID of the Group to delete.
def
get( self, *, uuid: str, include_trash: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[Group]:
1651 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1652 """Get a Group record by UUID. 1653 1654 Required parameters: 1655 1656 * uuid: str --- The UUID of the Group to return. 1657 1658 Optional parameters: 1659 1660 * include_trash: bool --- Return group/project even if its `is_trashed` attribute is true. Default `False`. 1661 1662 * select: Optional[List] --- An array of names of attributes to return in the response. 1663 """
Get a Group record by UUID.
Required parameters:
- uuid: str — The UUID of the Group to return.
Optional parameters:
include_trash: bool — Return group/project even if its
is_trashedattribute is true. DefaultFalse.select: Optional[List] — An array of names of attributes to return in the response.
def
list( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, include_trash: bool = False, limit: int = 100, offset: int = 0, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[GroupList]:
1665 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, include_trash: 'bool' = False, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[GroupList]': 1666 """Retrieve a GroupList. 1667 1668 This method returns a single page of `Group` objects that match your search 1669 criteria. If you just want to iterate all objects that match your search 1670 criteria, consider using `arvados.util.keyset_list_all`. 1671 1672 Optional parameters: 1673 1674 * bypass_federation: bool --- If true, do not return results from other clusters in the 1675 federation, only the cluster that received the request. 1676 You must be an administrator to use this flag. Default `False`. 1677 1678 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1679 1680 * count: str --- A string to determine result counting behavior. Supported values are: 1681 1682 * `"exact"`: The response will include an `items_available` field that 1683 counts the number of objects that matched this search criteria, 1684 including ones not included in `items`. 1685 1686 * `"none"`: The response will not include an `items_avaliable` 1687 field. This improves performance by returning a result as soon as enough 1688 `items` have been loaded for this result. 1689 1690 Default `'exact'`. 1691 1692 * distinct: bool --- If this is true, and multiple objects have the same values 1693 for the attributes that you specify in the `select` parameter, then each unique 1694 set of values will only be returned once in the result set. Default `False`. 1695 1696 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1697 Refer to the [filters reference][] for more information about how to write filters. 1698 1699 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1700 1701 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1702 1703 * limit: int --- The maximum number of objects to return in the result. 1704 Note that the API may return fewer results than this if your request hits other 1705 limits set by the administrator. Default `100`. 1706 1707 * offset: int --- Return matching objects starting from this index. 1708 Note that result indexes may change if objects are modified in between a series 1709 of list calls. Default `0`. 1710 1711 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1712 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1713 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1714 1715 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1716 1717 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1718 The keys of this object are attribute names. 1719 Each value is either a single matching value or an array of matching values for that attribute. 1720 The `filters` parameter is more flexible and preferred. 1721 """
Retrieve a GroupList.
This method returns a single page of Group objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.keyset_list_all.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
include_trash: bool — Include items whose
is_trashedattribute is true. DefaultFalse.limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
1783 def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1784 """Trash a group. 1785 1786 Required parameters: 1787 1788 * uuid: str --- The UUID of the Group to update. 1789 """
Trash a group.
Required parameters:
- uuid: str — The UUID of the Group to update.
1791 def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1792 """Untrash a group. 1793 1794 Required parameters: 1795 1796 * uuid: str --- The UUID of the Group to update. 1797 """
Untrash a group.
Required parameters:
- uuid: str — The UUID of the Group to update.
def
update( self, *, body: Dict[Literal['group'], Group], uuid: str, async_: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[Group]:
1799 def update(self, *, body: "Dict[Literal['group'], Group]", uuid: 'str', async_: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1800 """Update attributes of an existing Group. 1801 1802 Required parameters: 1803 1804 * body: Dict[Literal['group'], Group] --- A dictionary with a single item `'group'`. 1805 Its value is a `Group` dictionary defining the attributes to set. 1806 1807 * uuid: str --- The UUID of the Group to update. 1808 1809 Optional parameters: 1810 1811 * async: bool --- If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default `False`. 1812 1813 * select: Optional[List] --- An array of names of attributes to return in the response. 1814 """
Update attributes of an existing Group.
Required parameters:
body: Dict[Literal[’group’], Group] — A dictionary with a single item
'group'. Its value is aGroupdictionary defining the attributes to set.uuid: str — The UUID of the Group to update.
Optional parameters:
async: bool — If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
class
KeepService(typing.TypedDict):
1817class KeepService(TypedDict, total=False): 1818 """Arvados Keep service 1819 1820 This resource stores information about a single Keep service in this Arvados 1821 cluster that clients can contact to retrieve and store data. 1822 1823 This is the dictionary object that represents a single KeepService in Arvados 1824 and is returned by most `KeepServices` methods. 1825 The keys of the dictionary are documented below, along with their types. 1826 Not every key may appear in every dictionary returned by an API call. 1827 When a method doesn't return all the data, you can use its `select` parameter 1828 to list the specific keys you need. Refer to the API documentation for details. 1829 """ 1830 etag: 'str' 1831 """Object cache version.""" 1832 uuid: 'str' 1833 """This Keep service's Arvados UUID, like `zzzzz-bi6l4-12345abcde67890`.""" 1834 owner_uuid: 'str' 1835 """The UUID of the user or group that owns this Keep service.""" 1836 modified_by_user_uuid: 'str' 1837 """The UUID of the user that last updated this Keep service.""" 1838 modified_at: 'str' 1839 """The time this Keep service was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1840 service_host: 'str' 1841 """The DNS hostname of this Keep service.""" 1842 service_port: 'int' 1843 """The TCP port where this Keep service listens.""" 1844 service_ssl_flag: 'bool' 1845 """A boolean flag that indicates whether or not this Keep service uses TLS/SSL.""" 1846 service_type: 'str' 1847 """A string that describes which type of Keep service this is. One of: 1848 1849 * `"disk"` --- A service that stores blocks on a local filesystem. 1850 * `"blob"` --- A service that stores blocks in a cloud object store. 1851 * `"proxy"` --- A keepproxy service. 1852 """ 1853 created_at: 'str' 1854 """The time this Keep service was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1855 read_only: 'bool' 1856 """A boolean flag. If set, this Keep service does not accept requests to write data 1857 blocks; it only serves blocks it already has. 1858 """
Arvados Keep service
This resource stores information about a single Keep service in this Arvados cluster that clients can contact to retrieve and store data.
This is the dictionary object that represents a single KeepService in Arvados
and is returned by most KeepServices methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
modified_at: str
The time this Keep service was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
service_type: str
A string that describes which type of Keep service this is. One of:
"disk"— A service that stores blocks on a local filesystem."blob"— A service that stores blocks in a cloud object store."proxy"— A keepproxy service.
class
KeepServiceList(typing.TypedDict):
1861class KeepServiceList(TypedDict, total=False): 1862 """A list of KeepService objects. 1863 1864 This is the dictionary object returned when you call `KeepServices.list`. 1865 If you just want to iterate all objects that match your search criteria, 1866 consider using `arvados.util.keyset_list_all`. 1867 If you work with this raw object, the keys of the dictionary are documented 1868 below, along with their types. The `items` key maps to a list of matching 1869 `KeepService` objects. 1870 """ 1871 kind: 'str' = 'arvados#keepServiceList' 1872 """Object type. Always arvados#keepServiceList.""" 1873 etag: 'str' 1874 """List cache version.""" 1875 items: 'List[KeepService]' 1876 """An array of matching KeepService objects."""
A list of KeepService objects.
This is the dictionary object returned when you call KeepServices.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.keyset_list_all.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
KeepService objects.
class
KeepServices:
1879class KeepServices: 1880 """Methods to query and manipulate Arvados keep services""" 1881 1882 def accessible(self) -> 'ArvadosAPIRequest[KeepService]': 1883 """List Keep services that the current client can access.""" 1884 1885 def create(self, *, body: "Dict[Literal['keep_service'], KeepService]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1886 """Create a new KeepService. 1887 1888 Required parameters: 1889 1890 * body: Dict[Literal['keep_service'], KeepService] --- A dictionary with a single item `'keep_service'`. 1891 Its value is a `KeepService` dictionary defining the attributes to set. 1892 1893 Optional parameters: 1894 1895 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1896 1897 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 1898 1899 * select: Optional[List] --- An array of names of attributes to return in the response. 1900 """ 1901 1902 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[KeepService]': 1903 """Delete an existing KeepService. 1904 1905 Required parameters: 1906 1907 * uuid: str --- The UUID of the KeepService to delete. 1908 """ 1909 1910 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1911 """Get a KeepService record by UUID. 1912 1913 Required parameters: 1914 1915 * uuid: str --- The UUID of the KeepService to return. 1916 1917 Optional parameters: 1918 1919 * select: Optional[List] --- An array of names of attributes to return in the response. 1920 """ 1921 1922 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[KeepServiceList]': 1923 """Retrieve a KeepServiceList. 1924 1925 This method returns a single page of `KeepService` objects that match your search 1926 criteria. If you just want to iterate all objects that match your search 1927 criteria, consider using `arvados.util.keyset_list_all`. 1928 1929 Optional parameters: 1930 1931 * bypass_federation: bool --- If true, do not return results from other clusters in the 1932 federation, only the cluster that received the request. 1933 You must be an administrator to use this flag. Default `False`. 1934 1935 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1936 1937 * count: str --- A string to determine result counting behavior. Supported values are: 1938 1939 * `"exact"`: The response will include an `items_available` field that 1940 counts the number of objects that matched this search criteria, 1941 including ones not included in `items`. 1942 1943 * `"none"`: The response will not include an `items_avaliable` 1944 field. This improves performance by returning a result as soon as enough 1945 `items` have been loaded for this result. 1946 1947 Default `'exact'`. 1948 1949 * distinct: bool --- If this is true, and multiple objects have the same values 1950 for the attributes that you specify in the `select` parameter, then each unique 1951 set of values will only be returned once in the result set. Default `False`. 1952 1953 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1954 Refer to the [filters reference][] for more information about how to write filters. 1955 1956 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1957 1958 * limit: int --- The maximum number of objects to return in the result. 1959 Note that the API may return fewer results than this if your request hits other 1960 limits set by the administrator. Default `100`. 1961 1962 * offset: int --- Return matching objects starting from this index. 1963 Note that result indexes may change if objects are modified in between a series 1964 of list calls. Default `0`. 1965 1966 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1967 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1968 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1969 1970 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1971 1972 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1973 The keys of this object are attribute names. 1974 Each value is either a single matching value or an array of matching values for that attribute. 1975 The `filters` parameter is more flexible and preferred. 1976 """ 1977 1978 def update(self, *, body: "Dict[Literal['keep_service'], KeepService]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1979 """Update attributes of an existing KeepService. 1980 1981 Required parameters: 1982 1983 * body: Dict[Literal['keep_service'], KeepService] --- A dictionary with a single item `'keep_service'`. 1984 Its value is a `KeepService` dictionary defining the attributes to set. 1985 1986 * uuid: str --- The UUID of the KeepService to update. 1987 1988 Optional parameters: 1989 1990 * select: Optional[List] --- An array of names of attributes to return in the response. 1991 """
Methods to query and manipulate Arvados keep services
1882 def accessible(self) -> 'ArvadosAPIRequest[KeepService]': 1883 """List Keep services that the current client can access."""
List Keep services that the current client can access.
def
create( self, *, body: Dict[Literal['keep_service'], KeepService], cluster_id: Optional[str] = None, ensure_unique_name: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[KeepService]:
1885 def create(self, *, body: "Dict[Literal['keep_service'], KeepService]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1886 """Create a new KeepService. 1887 1888 Required parameters: 1889 1890 * body: Dict[Literal['keep_service'], KeepService] --- A dictionary with a single item `'keep_service'`. 1891 Its value is a `KeepService` dictionary defining the attributes to set. 1892 1893 Optional parameters: 1894 1895 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1896 1897 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 1898 1899 * select: Optional[List] --- An array of names of attributes to return in the response. 1900 """
Create a new KeepService.
Required parameters:
- body: Dict[Literal[’keep_service’], KeepService] — A dictionary with a single item
'keep_service'. Its value is aKeepServicedictionary defining the attributes to set.
Optional parameters:
cluster_id: Optional[str] — Cluster ID of a federated cluster where this object should be created.
ensure_unique_name: bool — If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
1902 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[KeepService]': 1903 """Delete an existing KeepService. 1904 1905 Required parameters: 1906 1907 * uuid: str --- The UUID of the KeepService to delete. 1908 """
Delete an existing KeepService.
Required parameters:
- uuid: str — The UUID of the KeepService to delete.
1910 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1911 """Get a KeepService record by UUID. 1912 1913 Required parameters: 1914 1915 * uuid: str --- The UUID of the KeepService to return. 1916 1917 Optional parameters: 1918 1919 * select: Optional[List] --- An array of names of attributes to return in the response. 1920 """
Get a KeepService record by UUID.
Required parameters:
- uuid: str — The UUID of the KeepService to return.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
def
list( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, limit: int = 100, offset: int = 0, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[KeepServiceList]:
1922 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[KeepServiceList]': 1923 """Retrieve a KeepServiceList. 1924 1925 This method returns a single page of `KeepService` objects that match your search 1926 criteria. If you just want to iterate all objects that match your search 1927 criteria, consider using `arvados.util.keyset_list_all`. 1928 1929 Optional parameters: 1930 1931 * bypass_federation: bool --- If true, do not return results from other clusters in the 1932 federation, only the cluster that received the request. 1933 You must be an administrator to use this flag. Default `False`. 1934 1935 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1936 1937 * count: str --- A string to determine result counting behavior. Supported values are: 1938 1939 * `"exact"`: The response will include an `items_available` field that 1940 counts the number of objects that matched this search criteria, 1941 including ones not included in `items`. 1942 1943 * `"none"`: The response will not include an `items_avaliable` 1944 field. This improves performance by returning a result as soon as enough 1945 `items` have been loaded for this result. 1946 1947 Default `'exact'`. 1948 1949 * distinct: bool --- If this is true, and multiple objects have the same values 1950 for the attributes that you specify in the `select` parameter, then each unique 1951 set of values will only be returned once in the result set. Default `False`. 1952 1953 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1954 Refer to the [filters reference][] for more information about how to write filters. 1955 1956 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1957 1958 * limit: int --- The maximum number of objects to return in the result. 1959 Note that the API may return fewer results than this if your request hits other 1960 limits set by the administrator. Default `100`. 1961 1962 * offset: int --- Return matching objects starting from this index. 1963 Note that result indexes may change if objects are modified in between a series 1964 of list calls. Default `0`. 1965 1966 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1967 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1968 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1969 1970 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1971 1972 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1973 The keys of this object are attribute names. 1974 Each value is either a single matching value or an array of matching values for that attribute. 1975 The `filters` parameter is more flexible and preferred. 1976 """
Retrieve a KeepServiceList.
This method returns a single page of KeepService objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.keyset_list_all.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
def
update( self, *, body: Dict[Literal['keep_service'], KeepService], uuid: str, select: Optional[List] = None) -> ArvadosAPIRequest[KeepService]:
1978 def update(self, *, body: "Dict[Literal['keep_service'], KeepService]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1979 """Update attributes of an existing KeepService. 1980 1981 Required parameters: 1982 1983 * body: Dict[Literal['keep_service'], KeepService] --- A dictionary with a single item `'keep_service'`. 1984 Its value is a `KeepService` dictionary defining the attributes to set. 1985 1986 * uuid: str --- The UUID of the KeepService to update. 1987 1988 Optional parameters: 1989 1990 * select: Optional[List] --- An array of names of attributes to return in the response. 1991 """
Update attributes of an existing KeepService.
Required parameters:
body: Dict[Literal[’keep_service’], KeepService] — A dictionary with a single item
'keep_service'. Its value is aKeepServicedictionary defining the attributes to set.uuid: str — The UUID of the KeepService to update.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
class
Link(typing.TypedDict):
1994class Link(TypedDict, total=False): 1995 """Arvados object link 1996 1997 A link provides a way to define relationships between Arvados objects, 1998 depending on their `link_class`. 1999 2000 This is the dictionary object that represents a single Link in Arvados 2001 and is returned by most `Links` methods. 2002 The keys of the dictionary are documented below, along with their types. 2003 Not every key may appear in every dictionary returned by an API call. 2004 When a method doesn't return all the data, you can use its `select` parameter 2005 to list the specific keys you need. Refer to the API documentation for details. 2006 """ 2007 etag: 'str' 2008 """Object cache version.""" 2009 uuid: 'str' 2010 """This link's Arvados UUID, like `zzzzz-o0j2j-12345abcde67890`.""" 2011 owner_uuid: 'str' 2012 """The UUID of the user or group that owns this link.""" 2013 created_at: 'str' 2014 """The time this link was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2015 modified_by_user_uuid: 'str' 2016 """The UUID of the user that last updated this link.""" 2017 modified_at: 'str' 2018 """The time this link was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2019 tail_uuid: 'str' 2020 """The UUID of the Arvados object that is the target of this relationship.""" 2021 link_class: 'str' 2022 """A string that defines which kind of link this is. One of: 2023 2024 * `"permission"` --- This link grants a permission to the user or group 2025 referenced by `head_uuid` to the object referenced by `tail_uuid`. The 2026 access level is set by `name`. 2027 * `"star"` --- This link represents a "favorite." The user referenced 2028 by `head_uuid` wants quick access to the object referenced by `tail_uuid`. 2029 * `"tag"` --- This link represents an unstructured metadata tag. The object 2030 referenced by `tail_uuid` has the tag defined by `name`. 2031 """ 2032 name: 'str' 2033 """The primary value of this link. For `"permission"` links, this is one of 2034 `"can_read"`, `"can_write"`, or `"can_manage"`. 2035 """ 2036 head_uuid: 'str' 2037 """The UUID of the Arvados object that is the originator or actor in this 2038 relationship. May be null. 2039 """ 2040 properties: 'Dict[str, Any]' 2041 """A hash of arbitrary metadata for this link. 2042 Some keys may be reserved by Arvados or defined by a configured vocabulary. 2043 Refer to the [metadata properties reference][] for details. 2044 2045 [metadata properties reference]: https://doc.arvados.org/api/properties.html 2046 """
Arvados object link
A link provides a way to define relationships between Arvados objects,
depending on their link_class.
This is the dictionary object that represents a single Link in Arvados
and is returned by most Links methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
created_at: str
The time this link was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
modified_at: str
The time this link was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
link_class: str
A string that defines which kind of link this is. One of:
"permission"— This link grants a permission to the user or group referenced byhead_uuidto the object referenced bytail_uuid. The access level is set byname."star"— This link represents a “favorite.” The user referenced byhead_uuidwants quick access to the object referenced bytail_uuid."tag"— This link represents an unstructured metadata tag. The object referenced bytail_uuidhas the tag defined byname.
name: str
The primary value of this link. For "permission" links, this is one of
"can_read", "can_write", or "can_manage".
head_uuid: str
The UUID of the Arvados object that is the originator or actor in this relationship. May be null.
properties: Dict[str, Any]
A hash of arbitrary metadata for this link. Some keys may be reserved by Arvados or defined by a configured vocabulary. Refer to the metadata properties reference for details.
class
LinkList(typing.TypedDict):
2049class LinkList(TypedDict, total=False): 2050 """A list of Link objects. 2051 2052 This is the dictionary object returned when you call `Links.list`. 2053 If you just want to iterate all objects that match your search criteria, 2054 consider using `arvados.util.keyset_list_all`. 2055 If you work with this raw object, the keys of the dictionary are documented 2056 below, along with their types. The `items` key maps to a list of matching 2057 `Link` objects. 2058 """ 2059 kind: 'str' = 'arvados#linkList' 2060 """Object type. Always arvados#linkList.""" 2061 etag: 'str' 2062 """List cache version.""" 2063 items: 'List[Link]' 2064 """An array of matching Link objects."""
A list of Link objects.
This is the dictionary object returned when you call Links.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.keyset_list_all.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
Link objects.
class
Links:
2067class Links: 2068 """Methods to query and manipulate Arvados links""" 2069 2070 def create(self, *, body: "Dict[Literal['link'], Link]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2071 """Create a new Link. 2072 2073 Required parameters: 2074 2075 * body: Dict[Literal['link'], Link] --- A dictionary with a single item `'link'`. 2076 Its value is a `Link` dictionary defining the attributes to set. 2077 2078 Optional parameters: 2079 2080 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2081 2082 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2083 2084 * select: Optional[List] --- An array of names of attributes to return in the response. 2085 """ 2086 2087 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]': 2088 """Delete an existing Link. 2089 2090 Required parameters: 2091 2092 * uuid: str --- The UUID of the Link to delete. 2093 """ 2094 2095 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2096 """Get a Link record by UUID. 2097 2098 Required parameters: 2099 2100 * uuid: str --- The UUID of the Link to return. 2101 2102 Optional parameters: 2103 2104 * select: Optional[List] --- An array of names of attributes to return in the response. 2105 """ 2106 2107 def get_permissions(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]': 2108 """List permissions granted on an Arvados object. 2109 2110 Required parameters: 2111 2112 * uuid: str --- The UUID of the Link to query. 2113 """ 2114 2115 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[LinkList]': 2116 """Retrieve a LinkList. 2117 2118 This method returns a single page of `Link` objects that match your search 2119 criteria. If you just want to iterate all objects that match your search 2120 criteria, consider using `arvados.util.keyset_list_all`. 2121 2122 Optional parameters: 2123 2124 * bypass_federation: bool --- If true, do not return results from other clusters in the 2125 federation, only the cluster that received the request. 2126 You must be an administrator to use this flag. Default `False`. 2127 2128 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2129 2130 * count: str --- A string to determine result counting behavior. Supported values are: 2131 2132 * `"exact"`: The response will include an `items_available` field that 2133 counts the number of objects that matched this search criteria, 2134 including ones not included in `items`. 2135 2136 * `"none"`: The response will not include an `items_avaliable` 2137 field. This improves performance by returning a result as soon as enough 2138 `items` have been loaded for this result. 2139 2140 Default `'exact'`. 2141 2142 * distinct: bool --- If this is true, and multiple objects have the same values 2143 for the attributes that you specify in the `select` parameter, then each unique 2144 set of values will only be returned once in the result set. Default `False`. 2145 2146 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2147 Refer to the [filters reference][] for more information about how to write filters. 2148 2149 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2150 2151 * limit: int --- The maximum number of objects to return in the result. 2152 Note that the API may return fewer results than this if your request hits other 2153 limits set by the administrator. Default `100`. 2154 2155 * offset: int --- Return matching objects starting from this index. 2156 Note that result indexes may change if objects are modified in between a series 2157 of list calls. Default `0`. 2158 2159 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2160 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2161 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2162 2163 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2164 2165 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2166 The keys of this object are attribute names. 2167 Each value is either a single matching value or an array of matching values for that attribute. 2168 The `filters` parameter is more flexible and preferred. 2169 """ 2170 2171 def update(self, *, body: "Dict[Literal['link'], Link]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2172 """Update attributes of an existing Link. 2173 2174 Required parameters: 2175 2176 * body: Dict[Literal['link'], Link] --- A dictionary with a single item `'link'`. 2177 Its value is a `Link` dictionary defining the attributes to set. 2178 2179 * uuid: str --- The UUID of the Link to update. 2180 2181 Optional parameters: 2182 2183 * select: Optional[List] --- An array of names of attributes to return in the response. 2184 """
Methods to query and manipulate Arvados links
def
create( self, *, body: Dict[Literal['link'], Link], cluster_id: Optional[str] = None, ensure_unique_name: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[Link]:
2070 def create(self, *, body: "Dict[Literal['link'], Link]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2071 """Create a new Link. 2072 2073 Required parameters: 2074 2075 * body: Dict[Literal['link'], Link] --- A dictionary with a single item `'link'`. 2076 Its value is a `Link` dictionary defining the attributes to set. 2077 2078 Optional parameters: 2079 2080 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2081 2082 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2083 2084 * select: Optional[List] --- An array of names of attributes to return in the response. 2085 """
Create a new Link.
Required parameters:
- body: Dict[Literal[’link’], Link] — A dictionary with a single item
'link'. Its value is aLinkdictionary defining the attributes to set.
Optional parameters:
cluster_id: Optional[str] — Cluster ID of a federated cluster where this object should be created.
ensure_unique_name: bool — If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
2087 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]': 2088 """Delete an existing Link. 2089 2090 Required parameters: 2091 2092 * uuid: str --- The UUID of the Link to delete. 2093 """
Delete an existing Link.
Required parameters:
- uuid: str — The UUID of the Link to delete.
2095 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2096 """Get a Link record by UUID. 2097 2098 Required parameters: 2099 2100 * uuid: str --- The UUID of the Link to return. 2101 2102 Optional parameters: 2103 2104 * select: Optional[List] --- An array of names of attributes to return in the response. 2105 """
Get a Link record by UUID.
Required parameters:
- uuid: str — The UUID of the Link to return.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
2107 def get_permissions(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]': 2108 """List permissions granted on an Arvados object. 2109 2110 Required parameters: 2111 2112 * uuid: str --- The UUID of the Link to query. 2113 """
List permissions granted on an Arvados object.
Required parameters:
- uuid: str — The UUID of the Link to query.
def
list( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, limit: int = 100, offset: int = 0, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[LinkList]:
2115 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[LinkList]': 2116 """Retrieve a LinkList. 2117 2118 This method returns a single page of `Link` objects that match your search 2119 criteria. If you just want to iterate all objects that match your search 2120 criteria, consider using `arvados.util.keyset_list_all`. 2121 2122 Optional parameters: 2123 2124 * bypass_federation: bool --- If true, do not return results from other clusters in the 2125 federation, only the cluster that received the request. 2126 You must be an administrator to use this flag. Default `False`. 2127 2128 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2129 2130 * count: str --- A string to determine result counting behavior. Supported values are: 2131 2132 * `"exact"`: The response will include an `items_available` field that 2133 counts the number of objects that matched this search criteria, 2134 including ones not included in `items`. 2135 2136 * `"none"`: The response will not include an `items_avaliable` 2137 field. This improves performance by returning a result as soon as enough 2138 `items` have been loaded for this result. 2139 2140 Default `'exact'`. 2141 2142 * distinct: bool --- If this is true, and multiple objects have the same values 2143 for the attributes that you specify in the `select` parameter, then each unique 2144 set of values will only be returned once in the result set. Default `False`. 2145 2146 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2147 Refer to the [filters reference][] for more information about how to write filters. 2148 2149 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2150 2151 * limit: int --- The maximum number of objects to return in the result. 2152 Note that the API may return fewer results than this if your request hits other 2153 limits set by the administrator. Default `100`. 2154 2155 * offset: int --- Return matching objects starting from this index. 2156 Note that result indexes may change if objects are modified in between a series 2157 of list calls. Default `0`. 2158 2159 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2160 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2161 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2162 2163 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2164 2165 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2166 The keys of this object are attribute names. 2167 Each value is either a single matching value or an array of matching values for that attribute. 2168 The `filters` parameter is more flexible and preferred. 2169 """
Retrieve a LinkList.
This method returns a single page of Link objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.keyset_list_all.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
def
update( self, *, body: Dict[Literal['link'], Link], uuid: str, select: Optional[List] = None) -> ArvadosAPIRequest[Link]:
2171 def update(self, *, body: "Dict[Literal['link'], Link]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2172 """Update attributes of an existing Link. 2173 2174 Required parameters: 2175 2176 * body: Dict[Literal['link'], Link] --- A dictionary with a single item `'link'`. 2177 Its value is a `Link` dictionary defining the attributes to set. 2178 2179 * uuid: str --- The UUID of the Link to update. 2180 2181 Optional parameters: 2182 2183 * select: Optional[List] --- An array of names of attributes to return in the response. 2184 """
Update attributes of an existing Link.
Required parameters:
body: Dict[Literal[’link’], Link] — A dictionary with a single item
'link'. Its value is aLinkdictionary defining the attributes to set.uuid: str — The UUID of the Link to update.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
class
Log(typing.TypedDict):
2187class Log(TypedDict, total=False): 2188 """Arvados log record 2189 2190 This resource represents a single log record about an event in this Arvados 2191 cluster. Some individual Arvados services create log records. Users can also 2192 create custom logs. 2193 2194 This is the dictionary object that represents a single Log in Arvados 2195 and is returned by most `Logs` methods. 2196 The keys of the dictionary are documented below, along with their types. 2197 Not every key may appear in every dictionary returned by an API call. 2198 When a method doesn't return all the data, you can use its `select` parameter 2199 to list the specific keys you need. Refer to the API documentation for details. 2200 """ 2201 etag: 'str' 2202 """Object cache version.""" 2203 id: 'int' 2204 """The serial number of this log. You can use this in filters to query logs 2205 that were created before/after another. 2206 """ 2207 uuid: 'str' 2208 """This log's Arvados UUID, like `zzzzz-57u5n-12345abcde67890`.""" 2209 owner_uuid: 'str' 2210 """The UUID of the user or group that owns this log.""" 2211 modified_by_user_uuid: 'str' 2212 """The UUID of the user that last updated this log.""" 2213 object_uuid: 'str' 2214 """The UUID of the Arvados object that this log pertains to, such as a user 2215 or container. 2216 """ 2217 event_at: 'str' 2218 """The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2219 event_type: 'str' 2220 """An arbitrary short string that classifies what type of log this is.""" 2221 summary: 'str' 2222 """A text string that describes the logged event. This is the primary 2223 attribute for simple logs. 2224 """ 2225 properties: 'Dict[str, Any]' 2226 """A hash of arbitrary metadata for this log. 2227 Some keys may be reserved by Arvados or defined by a configured vocabulary. 2228 Refer to the [metadata properties reference][] for details. 2229 2230 [metadata properties reference]: https://doc.arvados.org/api/properties.html 2231 """ 2232 created_at: 'str' 2233 """The time this log was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2234 modified_at: 'str' 2235 """The time this log was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2236 object_owner_uuid: 'str' 2237 """The `owner_uuid` of the object referenced by `object_uuid` at the time 2238 this log was created. 2239 """
Arvados log record
This resource represents a single log record about an event in this Arvados cluster. Some individual Arvados services create log records. Users can also create custom logs.
This is the dictionary object that represents a single Log in Arvados
and is returned by most Logs methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
id: int
The serial number of this log. You can use this in filters to query logs that were created before/after another.
object_uuid: str
The UUID of the Arvados object that this log pertains to, such as a user or container.
event_at: str
The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
summary: str
A text string that describes the logged event. This is the primary attribute for simple logs.
properties: Dict[str, Any]
A hash of arbitrary metadata for this log. Some keys may be reserved by Arvados or defined by a configured vocabulary. Refer to the metadata properties reference for details.
created_at: str
The time this log was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
modified_at: str
The time this log was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
object_owner_uuid: str
The owner_uuid of the object referenced by object_uuid at the time
this log was created.
class
LogList(typing.TypedDict):
2242class LogList(TypedDict, total=False): 2243 """A list of Log objects. 2244 2245 This is the dictionary object returned when you call `Logs.list`. 2246 If you just want to iterate all objects that match your search criteria, 2247 consider using `arvados.util.keyset_list_all`. 2248 If you work with this raw object, the keys of the dictionary are documented 2249 below, along with their types. The `items` key maps to a list of matching 2250 `Log` objects. 2251 """ 2252 kind: 'str' = 'arvados#logList' 2253 """Object type. Always arvados#logList.""" 2254 etag: 'str' 2255 """List cache version.""" 2256 items: 'List[Log]' 2257 """An array of matching Log objects."""
A list of Log objects.
This is the dictionary object returned when you call Logs.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.keyset_list_all.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
Log objects.
class
Logs:
2260class Logs: 2261 """Methods to query and manipulate Arvados logs""" 2262 2263 def create(self, *, body: "Dict[Literal['log'], Log]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2264 """Create a new Log. 2265 2266 Required parameters: 2267 2268 * body: Dict[Literal['log'], Log] --- A dictionary with a single item `'log'`. 2269 Its value is a `Log` dictionary defining the attributes to set. 2270 2271 Optional parameters: 2272 2273 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2274 2275 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2276 2277 * select: Optional[List] --- An array of names of attributes to return in the response. 2278 """ 2279 2280 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Log]': 2281 """Delete an existing Log. 2282 2283 Required parameters: 2284 2285 * uuid: str --- The UUID of the Log to delete. 2286 """ 2287 2288 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2289 """Get a Log record by UUID. 2290 2291 Required parameters: 2292 2293 * uuid: str --- The UUID of the Log to return. 2294 2295 Optional parameters: 2296 2297 * select: Optional[List] --- An array of names of attributes to return in the response. 2298 """ 2299 2300 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[LogList]': 2301 """Retrieve a LogList. 2302 2303 This method returns a single page of `Log` objects that match your search 2304 criteria. If you just want to iterate all objects that match your search 2305 criteria, consider using `arvados.util.keyset_list_all`. 2306 2307 Optional parameters: 2308 2309 * bypass_federation: bool --- If true, do not return results from other clusters in the 2310 federation, only the cluster that received the request. 2311 You must be an administrator to use this flag. Default `False`. 2312 2313 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2314 2315 * count: str --- A string to determine result counting behavior. Supported values are: 2316 2317 * `"exact"`: The response will include an `items_available` field that 2318 counts the number of objects that matched this search criteria, 2319 including ones not included in `items`. 2320 2321 * `"none"`: The response will not include an `items_avaliable` 2322 field. This improves performance by returning a result as soon as enough 2323 `items` have been loaded for this result. 2324 2325 Default `'exact'`. 2326 2327 * distinct: bool --- If this is true, and multiple objects have the same values 2328 for the attributes that you specify in the `select` parameter, then each unique 2329 set of values will only be returned once in the result set. Default `False`. 2330 2331 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2332 Refer to the [filters reference][] for more information about how to write filters. 2333 2334 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2335 2336 * limit: int --- The maximum number of objects to return in the result. 2337 Note that the API may return fewer results than this if your request hits other 2338 limits set by the administrator. Default `100`. 2339 2340 * offset: int --- Return matching objects starting from this index. 2341 Note that result indexes may change if objects are modified in between a series 2342 of list calls. Default `0`. 2343 2344 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2345 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2346 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2347 2348 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2349 2350 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2351 The keys of this object are attribute names. 2352 Each value is either a single matching value or an array of matching values for that attribute. 2353 The `filters` parameter is more flexible and preferred. 2354 """ 2355 2356 def update(self, *, body: "Dict[Literal['log'], Log]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2357 """Update attributes of an existing Log. 2358 2359 Required parameters: 2360 2361 * body: Dict[Literal['log'], Log] --- A dictionary with a single item `'log'`. 2362 Its value is a `Log` dictionary defining the attributes to set. 2363 2364 * uuid: str --- The UUID of the Log to update. 2365 2366 Optional parameters: 2367 2368 * select: Optional[List] --- An array of names of attributes to return in the response. 2369 """
Methods to query and manipulate Arvados logs
def
create( self, *, body: Dict[Literal['log'], Log], cluster_id: Optional[str] = None, ensure_unique_name: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[Log]:
2263 def create(self, *, body: "Dict[Literal['log'], Log]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2264 """Create a new Log. 2265 2266 Required parameters: 2267 2268 * body: Dict[Literal['log'], Log] --- A dictionary with a single item `'log'`. 2269 Its value is a `Log` dictionary defining the attributes to set. 2270 2271 Optional parameters: 2272 2273 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2274 2275 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2276 2277 * select: Optional[List] --- An array of names of attributes to return in the response. 2278 """
Create a new Log.
Required parameters:
- body: Dict[Literal[’log’], Log] — A dictionary with a single item
'log'. Its value is aLogdictionary defining the attributes to set.
Optional parameters:
cluster_id: Optional[str] — Cluster ID of a federated cluster where this object should be created.
ensure_unique_name: bool — If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
2280 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Log]': 2281 """Delete an existing Log. 2282 2283 Required parameters: 2284 2285 * uuid: str --- The UUID of the Log to delete. 2286 """
Delete an existing Log.
Required parameters:
- uuid: str — The UUID of the Log to delete.
2288 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2289 """Get a Log record by UUID. 2290 2291 Required parameters: 2292 2293 * uuid: str --- The UUID of the Log to return. 2294 2295 Optional parameters: 2296 2297 * select: Optional[List] --- An array of names of attributes to return in the response. 2298 """
Get a Log record by UUID.
Required parameters:
- uuid: str — The UUID of the Log to return.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
def
list( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, limit: int = 100, offset: int = 0, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[LogList]:
2300 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[LogList]': 2301 """Retrieve a LogList. 2302 2303 This method returns a single page of `Log` objects that match your search 2304 criteria. If you just want to iterate all objects that match your search 2305 criteria, consider using `arvados.util.keyset_list_all`. 2306 2307 Optional parameters: 2308 2309 * bypass_federation: bool --- If true, do not return results from other clusters in the 2310 federation, only the cluster that received the request. 2311 You must be an administrator to use this flag. Default `False`. 2312 2313 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2314 2315 * count: str --- A string to determine result counting behavior. Supported values are: 2316 2317 * `"exact"`: The response will include an `items_available` field that 2318 counts the number of objects that matched this search criteria, 2319 including ones not included in `items`. 2320 2321 * `"none"`: The response will not include an `items_avaliable` 2322 field. This improves performance by returning a result as soon as enough 2323 `items` have been loaded for this result. 2324 2325 Default `'exact'`. 2326 2327 * distinct: bool --- If this is true, and multiple objects have the same values 2328 for the attributes that you specify in the `select` parameter, then each unique 2329 set of values will only be returned once in the result set. Default `False`. 2330 2331 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2332 Refer to the [filters reference][] for more information about how to write filters. 2333 2334 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2335 2336 * limit: int --- The maximum number of objects to return in the result. 2337 Note that the API may return fewer results than this if your request hits other 2338 limits set by the administrator. Default `100`. 2339 2340 * offset: int --- Return matching objects starting from this index. 2341 Note that result indexes may change if objects are modified in between a series 2342 of list calls. Default `0`. 2343 2344 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2345 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2346 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2347 2348 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2349 2350 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2351 The keys of this object are attribute names. 2352 Each value is either a single matching value or an array of matching values for that attribute. 2353 The `filters` parameter is more flexible and preferred. 2354 """
Retrieve a LogList.
This method returns a single page of Log objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.keyset_list_all.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
def
update( self, *, body: Dict[Literal['log'], Log], uuid: str, select: Optional[List] = None) -> ArvadosAPIRequest[Log]:
2356 def update(self, *, body: "Dict[Literal['log'], Log]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2357 """Update attributes of an existing Log. 2358 2359 Required parameters: 2360 2361 * body: Dict[Literal['log'], Log] --- A dictionary with a single item `'log'`. 2362 Its value is a `Log` dictionary defining the attributes to set. 2363 2364 * uuid: str --- The UUID of the Log to update. 2365 2366 Optional parameters: 2367 2368 * select: Optional[List] --- An array of names of attributes to return in the response. 2369 """
Update attributes of an existing Log.
Required parameters:
body: Dict[Literal[’log’], Log] — A dictionary with a single item
'log'. Its value is aLogdictionary defining the attributes to set.uuid: str — The UUID of the Log to update.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
class
Sys:
2372class Sys: 2373 """Methods to query and manipulate Arvados sys""" 2374 2375 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 2376 """Run scheduled data trash and sweep operations across this cluster's Keep services."""
Methods to query and manipulate Arvados sys
class
UserAgreement(typing.TypedDict):
2379class UserAgreement(TypedDict, total=False): 2380 """Arvados user agreement 2381 2382 A user agreement is a collection with terms that users must agree to before 2383 they can use this Arvados cluster. 2384 2385 This is the dictionary object that represents a single UserAgreement in Arvados 2386 and is returned by most `UserAgreements` methods. 2387 The keys of the dictionary are documented below, along with their types. 2388 Not every key may appear in every dictionary returned by an API call. 2389 When a method doesn't return all the data, you can use its `select` parameter 2390 to list the specific keys you need. Refer to the API documentation for details. 2391 """ 2392 etag: 'str' 2393 """Object cache version.""" 2394 owner_uuid: 'str' 2395 """The UUID of the user or group that owns this user agreement.""" 2396 created_at: 'str' 2397 """The time this user agreement was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2398 modified_by_user_uuid: 'str' 2399 """The UUID of the user that last updated this user agreement.""" 2400 modified_at: 'str' 2401 """The time this user agreement was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2402 portable_data_hash: 'str' 2403 """The portable data hash of this user agreement. This string provides a unique 2404 and stable reference to these contents. 2405 """ 2406 replication_desired: 'int' 2407 """The number of copies that should be made for data in this user agreement.""" 2408 replication_confirmed_at: 'str' 2409 """The last time the cluster confirmed that it met `replication_confirmed` 2410 for this user agreement. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`. 2411 """ 2412 replication_confirmed: 'int' 2413 """The number of copies of data in this user agreement that the cluster has confirmed 2414 exist in storage. 2415 """ 2416 uuid: 'str' 2417 """This user agreement's Arvados UUID, like `zzzzz-gv0sa-12345abcde67890`.""" 2418 manifest_text: 'str' 2419 """The manifest text that describes how files are constructed from data blocks 2420 in this user agreement. Refer to the [manifest format][] reference for details. 2421 2422 [manifest format]: https://doc.arvados.org/architecture/manifest-format.html 2423 """ 2424 name: 'str' 2425 """The name of this user agreement assigned by a user.""" 2426 description: 'str' 2427 """A longer HTML description of this user agreement assigned by a user. 2428 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 2429 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 2430 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 2431 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 2432 """ 2433 properties: 'Dict[str, Any]' 2434 """A hash of arbitrary metadata for this user agreement. 2435 Some keys may be reserved by Arvados or defined by a configured vocabulary. 2436 Refer to the [metadata properties reference][] for details. 2437 2438 [metadata properties reference]: https://doc.arvados.org/api/properties.html 2439 """ 2440 delete_at: 'str' 2441 """The time this user agreement will be permanently deleted. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2442 trash_at: 'str' 2443 """The time this user agreement will be trashed. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2444 is_trashed: 'bool' 2445 """A boolean flag to indicate whether or not this user agreement is trashed.""" 2446 storage_classes_desired: 'List' 2447 """An array of strings identifying the storage class(es) that should be used 2448 for data in this user agreement. Storage classes are configured by the cluster administrator. 2449 """ 2450 storage_classes_confirmed: 'List' 2451 """An array of strings identifying the storage class(es) the cluster has 2452 confirmed have a copy of this user agreement's data. 2453 """ 2454 storage_classes_confirmed_at: 'str' 2455 """The last time the cluster confirmed that data was stored on the storage 2456 class(es) in `storage_classes_confirmed`. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`. 2457 """ 2458 current_version_uuid: 'str' 2459 """The UUID of the current version of this user agreement.""" 2460 version: 'int' 2461 """An integer that counts which version of a user agreement this record 2462 represents. Refer to [collection versioning][] for details. This attribute is 2463 read-only. 2464 2465 [collection versioning]: https://doc.arvados.org/user/topics/collection-versioning.html 2466 """ 2467 preserve_version: 'bool' 2468 """A boolean flag to indicate whether this specific version of this user agreement 2469 should be persisted in cluster storage. 2470 """ 2471 file_count: 'int' 2472 """The number of files represented in this user agreement's `manifest_text`. 2473 This attribute is read-only. 2474 """ 2475 file_size_total: 'int' 2476 """The total size in bytes of files represented in this user agreement's `manifest_text`. 2477 This attribute is read-only. 2478 """
Arvados user agreement
A user agreement is a collection with terms that users must agree to before they can use this Arvados cluster.
This is the dictionary object that represents a single UserAgreement in Arvados
and is returned by most UserAgreements methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
created_at: str
The time this user agreement was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
modified_at: str
The time this user agreement was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
portable_data_hash: str
The portable data hash of this user agreement. This string provides a unique and stable reference to these contents.
replication_confirmed_at: str
The last time the cluster confirmed that it met replication_confirmed
for this user agreement. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
replication_confirmed: int
The number of copies of data in this user agreement that the cluster has confirmed exist in storage.
manifest_text: str
The manifest text that describes how files are constructed from data blocks in this user agreement. Refer to the manifest format reference for details.
description: str
A longer HTML description of this user agreement assigned by a user.
Allowed HTML tags are a, b, blockquote, br, code,
del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr,
i, img, kbd, li, ol, p, pre,
s, section, span, strong, sub, sup, and ul.
properties: Dict[str, Any]
A hash of arbitrary metadata for this user agreement. Some keys may be reserved by Arvados or defined by a configured vocabulary. Refer to the metadata properties reference for details.
delete_at: str
The time this user agreement will be permanently deleted. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
trash_at: str
The time this user agreement will be trashed. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
storage_classes_desired: List
An array of strings identifying the storage class(es) that should be used for data in this user agreement. Storage classes are configured by the cluster administrator.
storage_classes_confirmed: List
An array of strings identifying the storage class(es) the cluster has confirmed have a copy of this user agreement’s data.
storage_classes_confirmed_at: str
The last time the cluster confirmed that data was stored on the storage
class(es) in storage_classes_confirmed. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
version: int
An integer that counts which version of a user agreement this record represents. Refer to collection versioning for details. This attribute is read-only.
preserve_version: bool
A boolean flag to indicate whether this specific version of this user agreement should be persisted in cluster storage.
file_count: int
The number of files represented in this user agreement’s manifest_text.
This attribute is read-only.
file_size_total: int
The total size in bytes of files represented in this user agreement’s manifest_text.
This attribute is read-only.
class
UserAgreementList(typing.TypedDict):
2481class UserAgreementList(TypedDict, total=False): 2482 """A list of UserAgreement objects. 2483 2484 This is the dictionary object returned when you call `UserAgreements.list`. 2485 If you just want to iterate all objects that match your search criteria, 2486 consider using `arvados.util.keyset_list_all`. 2487 If you work with this raw object, the keys of the dictionary are documented 2488 below, along with their types. The `items` key maps to a list of matching 2489 `UserAgreement` objects. 2490 """ 2491 kind: 'str' = 'arvados#userAgreementList' 2492 """Object type. Always arvados#userAgreementList.""" 2493 etag: 'str' 2494 """List cache version.""" 2495 items: 'List[UserAgreement]' 2496 """An array of matching UserAgreement objects."""
A list of UserAgreement objects.
This is the dictionary object returned when you call UserAgreements.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.keyset_list_all.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
UserAgreement objects.
class
UserAgreements:
2499class UserAgreements: 2500 """Methods to query and manipulate Arvados user agreements""" 2501 2502 def create(self, *, body: "Dict[Literal['user_agreement'], UserAgreement]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2503 """Create a new UserAgreement. 2504 2505 Required parameters: 2506 2507 * body: Dict[Literal['user_agreement'], UserAgreement] --- A dictionary with a single item `'user_agreement'`. 2508 Its value is a `UserAgreement` dictionary defining the attributes to set. 2509 2510 Optional parameters: 2511 2512 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2513 2514 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2515 2516 * select: Optional[List] --- An array of names of attributes to return in the response. 2517 """ 2518 2519 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[UserAgreement]': 2520 """Delete an existing UserAgreement. 2521 2522 Required parameters: 2523 2524 * uuid: str --- The UUID of the UserAgreement to delete. 2525 """ 2526 2527 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2528 """Get a UserAgreement record by UUID. 2529 2530 Required parameters: 2531 2532 * uuid: str --- The UUID of the UserAgreement to return. 2533 2534 Optional parameters: 2535 2536 * select: Optional[List] --- An array of names of attributes to return in the response. 2537 """ 2538 2539 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[UserAgreementList]': 2540 """Retrieve a UserAgreementList. 2541 2542 This method returns a single page of `UserAgreement` objects that match your search 2543 criteria. If you just want to iterate all objects that match your search 2544 criteria, consider using `arvados.util.keyset_list_all`. 2545 2546 Optional parameters: 2547 2548 * bypass_federation: bool --- If true, do not return results from other clusters in the 2549 federation, only the cluster that received the request. 2550 You must be an administrator to use this flag. Default `False`. 2551 2552 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2553 2554 * count: str --- A string to determine result counting behavior. Supported values are: 2555 2556 * `"exact"`: The response will include an `items_available` field that 2557 counts the number of objects that matched this search criteria, 2558 including ones not included in `items`. 2559 2560 * `"none"`: The response will not include an `items_avaliable` 2561 field. This improves performance by returning a result as soon as enough 2562 `items` have been loaded for this result. 2563 2564 Default `'exact'`. 2565 2566 * distinct: bool --- If this is true, and multiple objects have the same values 2567 for the attributes that you specify in the `select` parameter, then each unique 2568 set of values will only be returned once in the result set. Default `False`. 2569 2570 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2571 Refer to the [filters reference][] for more information about how to write filters. 2572 2573 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2574 2575 * limit: int --- The maximum number of objects to return in the result. 2576 Note that the API may return fewer results than this if your request hits other 2577 limits set by the administrator. Default `100`. 2578 2579 * offset: int --- Return matching objects starting from this index. 2580 Note that result indexes may change if objects are modified in between a series 2581 of list calls. Default `0`. 2582 2583 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2584 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2585 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2586 2587 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2588 2589 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2590 The keys of this object are attribute names. 2591 Each value is either a single matching value or an array of matching values for that attribute. 2592 The `filters` parameter is more flexible and preferred. 2593 """ 2594 2595 def sign(self) -> 'ArvadosAPIRequest[UserAgreement]': 2596 """Create a signature link from the current user for a given user agreement.""" 2597 2598 def signatures(self) -> 'ArvadosAPIRequest[UserAgreement]': 2599 """List all user agreement signature links from a user.""" 2600 2601 def update(self, *, body: "Dict[Literal['user_agreement'], UserAgreement]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2602 """Update attributes of an existing UserAgreement. 2603 2604 Required parameters: 2605 2606 * body: Dict[Literal['user_agreement'], UserAgreement] --- A dictionary with a single item `'user_agreement'`. 2607 Its value is a `UserAgreement` dictionary defining the attributes to set. 2608 2609 * uuid: str --- The UUID of the UserAgreement to update. 2610 2611 Optional parameters: 2612 2613 * select: Optional[List] --- An array of names of attributes to return in the response. 2614 """
Methods to query and manipulate Arvados user agreements
def
create( self, *, body: Dict[Literal['user_agreement'], UserAgreement], cluster_id: Optional[str] = None, ensure_unique_name: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[UserAgreement]:
2502 def create(self, *, body: "Dict[Literal['user_agreement'], UserAgreement]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2503 """Create a new UserAgreement. 2504 2505 Required parameters: 2506 2507 * body: Dict[Literal['user_agreement'], UserAgreement] --- A dictionary with a single item `'user_agreement'`. 2508 Its value is a `UserAgreement` dictionary defining the attributes to set. 2509 2510 Optional parameters: 2511 2512 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2513 2514 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2515 2516 * select: Optional[List] --- An array of names of attributes to return in the response. 2517 """
Create a new UserAgreement.
Required parameters:
- body: Dict[Literal[’user_agreement’], UserAgreement] — A dictionary with a single item
'user_agreement'. Its value is aUserAgreementdictionary defining the attributes to set.
Optional parameters:
cluster_id: Optional[str] — Cluster ID of a federated cluster where this object should be created.
ensure_unique_name: bool — If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
2519 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[UserAgreement]': 2520 """Delete an existing UserAgreement. 2521 2522 Required parameters: 2523 2524 * uuid: str --- The UUID of the UserAgreement to delete. 2525 """
Delete an existing UserAgreement.
Required parameters:
- uuid: str — The UUID of the UserAgreement to delete.
2527 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2528 """Get a UserAgreement record by UUID. 2529 2530 Required parameters: 2531 2532 * uuid: str --- The UUID of the UserAgreement to return. 2533 2534 Optional parameters: 2535 2536 * select: Optional[List] --- An array of names of attributes to return in the response. 2537 """
Get a UserAgreement record by UUID.
Required parameters:
- uuid: str — The UUID of the UserAgreement to return.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
def
list( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, limit: int = 100, offset: int = 0, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[UserAgreementList]:
2539 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[UserAgreementList]': 2540 """Retrieve a UserAgreementList. 2541 2542 This method returns a single page of `UserAgreement` objects that match your search 2543 criteria. If you just want to iterate all objects that match your search 2544 criteria, consider using `arvados.util.keyset_list_all`. 2545 2546 Optional parameters: 2547 2548 * bypass_federation: bool --- If true, do not return results from other clusters in the 2549 federation, only the cluster that received the request. 2550 You must be an administrator to use this flag. Default `False`. 2551 2552 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2553 2554 * count: str --- A string to determine result counting behavior. Supported values are: 2555 2556 * `"exact"`: The response will include an `items_available` field that 2557 counts the number of objects that matched this search criteria, 2558 including ones not included in `items`. 2559 2560 * `"none"`: The response will not include an `items_avaliable` 2561 field. This improves performance by returning a result as soon as enough 2562 `items` have been loaded for this result. 2563 2564 Default `'exact'`. 2565 2566 * distinct: bool --- If this is true, and multiple objects have the same values 2567 for the attributes that you specify in the `select` parameter, then each unique 2568 set of values will only be returned once in the result set. Default `False`. 2569 2570 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2571 Refer to the [filters reference][] for more information about how to write filters. 2572 2573 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2574 2575 * limit: int --- The maximum number of objects to return in the result. 2576 Note that the API may return fewer results than this if your request hits other 2577 limits set by the administrator. Default `100`. 2578 2579 * offset: int --- Return matching objects starting from this index. 2580 Note that result indexes may change if objects are modified in between a series 2581 of list calls. Default `0`. 2582 2583 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2584 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2585 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2586 2587 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2588 2589 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2590 The keys of this object are attribute names. 2591 Each value is either a single matching value or an array of matching values for that attribute. 2592 The `filters` parameter is more flexible and preferred. 2593 """
Retrieve a UserAgreementList.
This method returns a single page of UserAgreement objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.keyset_list_all.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
2595 def sign(self) -> 'ArvadosAPIRequest[UserAgreement]': 2596 """Create a signature link from the current user for a given user agreement."""
Create a signature link from the current user for a given user agreement.
2598 def signatures(self) -> 'ArvadosAPIRequest[UserAgreement]': 2599 """List all user agreement signature links from a user."""
List all user agreement signature links from a user.
def
update( self, *, body: Dict[Literal['user_agreement'], UserAgreement], uuid: str, select: Optional[List] = None) -> ArvadosAPIRequest[UserAgreement]:
2601 def update(self, *, body: "Dict[Literal['user_agreement'], UserAgreement]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2602 """Update attributes of an existing UserAgreement. 2603 2604 Required parameters: 2605 2606 * body: Dict[Literal['user_agreement'], UserAgreement] --- A dictionary with a single item `'user_agreement'`. 2607 Its value is a `UserAgreement` dictionary defining the attributes to set. 2608 2609 * uuid: str --- The UUID of the UserAgreement to update. 2610 2611 Optional parameters: 2612 2613 * select: Optional[List] --- An array of names of attributes to return in the response. 2614 """
Update attributes of an existing UserAgreement.
Required parameters:
body: Dict[Literal[’user_agreement’], UserAgreement] — A dictionary with a single item
'user_agreement'. Its value is aUserAgreementdictionary defining the attributes to set.uuid: str — The UUID of the UserAgreement to update.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
class
User(typing.TypedDict):
2617class User(TypedDict, total=False): 2618 """Arvados user 2619 2620 A user represents a single individual or role who may be authorized to access 2621 this Arvados cluster. 2622 2623 This is the dictionary object that represents a single User in Arvados 2624 and is returned by most `Users` methods. 2625 The keys of the dictionary are documented below, along with their types. 2626 Not every key may appear in every dictionary returned by an API call. 2627 When a method doesn't return all the data, you can use its `select` parameter 2628 to list the specific keys you need. Refer to the API documentation for details. 2629 """ 2630 etag: 'str' 2631 """Object cache version.""" 2632 uuid: 'str' 2633 """This user's Arvados UUID, like `zzzzz-tpzed-12345abcde67890`.""" 2634 owner_uuid: 'str' 2635 """The UUID of the user or group that owns this user.""" 2636 created_at: 'str' 2637 """The time this user was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2638 modified_by_user_uuid: 'str' 2639 """The UUID of the user that last updated this user.""" 2640 modified_at: 'str' 2641 """The time this user was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2642 email: 'str' 2643 """This user's email address.""" 2644 first_name: 'str' 2645 """This user's first name.""" 2646 last_name: 'str' 2647 """This user's last name.""" 2648 identity_url: 'str' 2649 """A URL that represents this user with the cluster's identity provider.""" 2650 is_admin: 'bool' 2651 """A boolean flag. If set, this user is an administrator of the Arvados 2652 cluster, and automatically passes most permissions checks. 2653 """ 2654 prefs: 'Dict[str, Any]' 2655 """A hash that stores cluster-wide user preferences.""" 2656 is_active: 'bool' 2657 """A boolean flag. If unset, this user is not permitted to make any Arvados 2658 API requests. 2659 """ 2660 username: 'str' 2661 """This user's Unix username on virtual machines."""
Arvados user
A user represents a single individual or role who may be authorized to access this Arvados cluster.
This is the dictionary object that represents a single User in Arvados
and is returned by most Users methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
created_at: str
The time this user was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
modified_at: str
The time this user was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
is_admin: bool
A boolean flag. If set, this user is an administrator of the Arvados cluster, and automatically passes most permissions checks.
class
UserList(typing.TypedDict):
2664class UserList(TypedDict, total=False): 2665 """A list of User objects. 2666 2667 This is the dictionary object returned when you call `Users.list`. 2668 If you just want to iterate all objects that match your search criteria, 2669 consider using `arvados.util.keyset_list_all`. 2670 If you work with this raw object, the keys of the dictionary are documented 2671 below, along with their types. The `items` key maps to a list of matching 2672 `User` objects. 2673 """ 2674 kind: 'str' = 'arvados#userList' 2675 """Object type. Always arvados#userList.""" 2676 etag: 'str' 2677 """List cache version.""" 2678 items: 'List[User]' 2679 """An array of matching User objects."""
A list of User objects.
This is the dictionary object returned when you call Users.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.keyset_list_all.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
User objects.
class
Users:
2682class Users: 2683 """Methods to query and manipulate Arvados users""" 2684 2685 def activate(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2686 """Set the `is_active` flag on a user record. 2687 2688 Required parameters: 2689 2690 * uuid: str --- The UUID of the User to update. 2691 """ 2692 2693 def create(self, *, body: "Dict[Literal['user'], User]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2694 """Create a new User. 2695 2696 Required parameters: 2697 2698 * body: Dict[Literal['user'], User] --- A dictionary with a single item `'user'`. 2699 Its value is a `User` dictionary defining the attributes to set. 2700 2701 Optional parameters: 2702 2703 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2704 2705 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2706 2707 * select: Optional[List] --- An array of names of attributes to return in the response. 2708 """ 2709 2710 def current(self) -> 'ArvadosAPIRequest[User]': 2711 """Return the user record associated with the API token authorizing this request.""" 2712 2713 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2714 """Delete an existing User. 2715 2716 Required parameters: 2717 2718 * uuid: str --- The UUID of the User to delete. 2719 """ 2720 2721 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2722 """Get a User record by UUID. 2723 2724 Required parameters: 2725 2726 * uuid: str --- The UUID of the User to return. 2727 2728 Optional parameters: 2729 2730 * select: Optional[List] --- An array of names of attributes to return in the response. 2731 """ 2732 2733 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[UserList]': 2734 """Retrieve a UserList. 2735 2736 This method returns a single page of `User` objects that match your search 2737 criteria. If you just want to iterate all objects that match your search 2738 criteria, consider using `arvados.util.keyset_list_all`. 2739 2740 Optional parameters: 2741 2742 * bypass_federation: bool --- If true, do not return results from other clusters in the 2743 federation, only the cluster that received the request. 2744 You must be an administrator to use this flag. Default `False`. 2745 2746 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2747 2748 * count: str --- A string to determine result counting behavior. Supported values are: 2749 2750 * `"exact"`: The response will include an `items_available` field that 2751 counts the number of objects that matched this search criteria, 2752 including ones not included in `items`. 2753 2754 * `"none"`: The response will not include an `items_avaliable` 2755 field. This improves performance by returning a result as soon as enough 2756 `items` have been loaded for this result. 2757 2758 Default `'exact'`. 2759 2760 * distinct: bool --- If this is true, and multiple objects have the same values 2761 for the attributes that you specify in the `select` parameter, then each unique 2762 set of values will only be returned once in the result set. Default `False`. 2763 2764 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2765 Refer to the [filters reference][] for more information about how to write filters. 2766 2767 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2768 2769 * limit: int --- The maximum number of objects to return in the result. 2770 Note that the API may return fewer results than this if your request hits other 2771 limits set by the administrator. Default `100`. 2772 2773 * offset: int --- Return matching objects starting from this index. 2774 Note that result indexes may change if objects are modified in between a series 2775 of list calls. Default `0`. 2776 2777 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2778 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2779 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2780 2781 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2782 2783 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2784 The keys of this object are attribute names. 2785 Each value is either a single matching value or an array of matching values for that attribute. 2786 The `filters` parameter is more flexible and preferred. 2787 """ 2788 2789 def merge(self, *, new_owner_uuid: 'str', new_user_token: 'Optional[str]' = None, new_user_uuid: 'Optional[str]' = None, old_user_uuid: 'Optional[str]' = None, redirect_to_new_user: 'bool' = False) -> 'ArvadosAPIRequest[User]': 2790 """Transfer ownership of one user's data to another. 2791 2792 Required parameters: 2793 2794 * new_owner_uuid: str --- UUID of the user or group that will take ownership of data owned by the old user. 2795 2796 Optional parameters: 2797 2798 * new_user_token: Optional[str] --- Valid API token for the user receiving ownership. If you use this option, it takes ownership of data owned by the user making the request. 2799 2800 * new_user_uuid: Optional[str] --- UUID of the user receiving ownership. You must be an admin to use this option. 2801 2802 * old_user_uuid: Optional[str] --- UUID of the user whose ownership is being transferred to `new_owner_uuid`. You must be an admin to use this option. 2803 2804 * redirect_to_new_user: bool --- If true, authorization attempts for the old user will be redirected to the new user. Default `False`. 2805 """ 2806 2807 def setup(self, *, repo_name: 'Optional[str]' = None, send_notification_email: 'bool' = False, user: 'Optional[Dict[str, Any]]' = None, uuid: 'Optional[str]' = None, vm_uuid: 'Optional[str]' = None) -> 'ArvadosAPIRequest[User]': 2808 """Convenience method to "fully" set up a user record with a virtual machine login and notification email. 2809 2810 Optional parameters: 2811 2812 * repo_name: Optional[str] --- This parameter is obsolete and ignored. 2813 2814 * send_notification_email: bool --- If true, send an email to the user notifying them they can now access this Arvados cluster. Default `False`. 2815 2816 * user: Optional[Dict[str, Any]] --- Attributes of a new user record to set up. 2817 2818 * uuid: Optional[str] --- UUID of an existing user record to set up. 2819 2820 * vm_uuid: Optional[str] --- If given, setup creates a login link to allow this user to access the Arvados virtual machine with this UUID. 2821 """ 2822 2823 def system(self) -> 'ArvadosAPIRequest[User]': 2824 """Return this cluster's system ("root") user record.""" 2825 2826 def unsetup(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2827 """Unset a user's active flag and delete associated records. 2828 2829 Required parameters: 2830 2831 * uuid: str --- The UUID of the User to update. 2832 """ 2833 2834 def update(self, *, body: "Dict[Literal['user'], User]", uuid: 'str', bypass_federation: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2835 """Update attributes of an existing User. 2836 2837 Required parameters: 2838 2839 * body: Dict[Literal['user'], User] --- A dictionary with a single item `'user'`. 2840 Its value is a `User` dictionary defining the attributes to set. 2841 2842 * uuid: str --- The UUID of the User to update. 2843 2844 Optional parameters: 2845 2846 * bypass_federation: bool --- If true, do not try to update the user on any other clusters in the federation, 2847 only the cluster that received the request. 2848 You must be an administrator to use this flag. Default `False`. 2849 2850 * select: Optional[List] --- An array of names of attributes to return in the response. 2851 """
Methods to query and manipulate Arvados users
2685 def activate(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2686 """Set the `is_active` flag on a user record. 2687 2688 Required parameters: 2689 2690 * uuid: str --- The UUID of the User to update. 2691 """
Set the is_active flag on a user record.
Required parameters:
- uuid: str — The UUID of the User to update.
def
create( self, *, body: Dict[Literal['user'], User], cluster_id: Optional[str] = None, ensure_unique_name: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[User]:
2693 def create(self, *, body: "Dict[Literal['user'], User]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2694 """Create a new User. 2695 2696 Required parameters: 2697 2698 * body: Dict[Literal['user'], User] --- A dictionary with a single item `'user'`. 2699 Its value is a `User` dictionary defining the attributes to set. 2700 2701 Optional parameters: 2702 2703 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2704 2705 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2706 2707 * select: Optional[List] --- An array of names of attributes to return in the response. 2708 """
Create a new User.
Required parameters:
- body: Dict[Literal[’user’], User] — A dictionary with a single item
'user'. Its value is aUserdictionary defining the attributes to set.
Optional parameters:
cluster_id: Optional[str] — Cluster ID of a federated cluster where this object should be created.
ensure_unique_name: bool — If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
2710 def current(self) -> 'ArvadosAPIRequest[User]': 2711 """Return the user record associated with the API token authorizing this request."""
Return the user record associated with the API token authorizing this request.
2713 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2714 """Delete an existing User. 2715 2716 Required parameters: 2717 2718 * uuid: str --- The UUID of the User to delete. 2719 """
Delete an existing User.
Required parameters:
- uuid: str — The UUID of the User to delete.
2721 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2722 """Get a User record by UUID. 2723 2724 Required parameters: 2725 2726 * uuid: str --- The UUID of the User to return. 2727 2728 Optional parameters: 2729 2730 * select: Optional[List] --- An array of names of attributes to return in the response. 2731 """
Get a User record by UUID.
Required parameters:
- uuid: str — The UUID of the User to return.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
def
list( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, limit: int = 100, offset: int = 0, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[UserList]:
2733 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[UserList]': 2734 """Retrieve a UserList. 2735 2736 This method returns a single page of `User` objects that match your search 2737 criteria. If you just want to iterate all objects that match your search 2738 criteria, consider using `arvados.util.keyset_list_all`. 2739 2740 Optional parameters: 2741 2742 * bypass_federation: bool --- If true, do not return results from other clusters in the 2743 federation, only the cluster that received the request. 2744 You must be an administrator to use this flag. Default `False`. 2745 2746 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2747 2748 * count: str --- A string to determine result counting behavior. Supported values are: 2749 2750 * `"exact"`: The response will include an `items_available` field that 2751 counts the number of objects that matched this search criteria, 2752 including ones not included in `items`. 2753 2754 * `"none"`: The response will not include an `items_avaliable` 2755 field. This improves performance by returning a result as soon as enough 2756 `items` have been loaded for this result. 2757 2758 Default `'exact'`. 2759 2760 * distinct: bool --- If this is true, and multiple objects have the same values 2761 for the attributes that you specify in the `select` parameter, then each unique 2762 set of values will only be returned once in the result set. Default `False`. 2763 2764 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2765 Refer to the [filters reference][] for more information about how to write filters. 2766 2767 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2768 2769 * limit: int --- The maximum number of objects to return in the result. 2770 Note that the API may return fewer results than this if your request hits other 2771 limits set by the administrator. Default `100`. 2772 2773 * offset: int --- Return matching objects starting from this index. 2774 Note that result indexes may change if objects are modified in between a series 2775 of list calls. Default `0`. 2776 2777 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2778 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2779 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2780 2781 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2782 2783 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2784 The keys of this object are attribute names. 2785 Each value is either a single matching value or an array of matching values for that attribute. 2786 The `filters` parameter is more flexible and preferred. 2787 """
Retrieve a UserList.
This method returns a single page of User objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.keyset_list_all.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
def
merge( self, *, new_owner_uuid: str, new_user_token: Optional[str] = None, new_user_uuid: Optional[str] = None, old_user_uuid: Optional[str] = None, redirect_to_new_user: bool = False) -> ArvadosAPIRequest[User]:
2789 def merge(self, *, new_owner_uuid: 'str', new_user_token: 'Optional[str]' = None, new_user_uuid: 'Optional[str]' = None, old_user_uuid: 'Optional[str]' = None, redirect_to_new_user: 'bool' = False) -> 'ArvadosAPIRequest[User]': 2790 """Transfer ownership of one user's data to another. 2791 2792 Required parameters: 2793 2794 * new_owner_uuid: str --- UUID of the user or group that will take ownership of data owned by the old user. 2795 2796 Optional parameters: 2797 2798 * new_user_token: Optional[str] --- Valid API token for the user receiving ownership. If you use this option, it takes ownership of data owned by the user making the request. 2799 2800 * new_user_uuid: Optional[str] --- UUID of the user receiving ownership. You must be an admin to use this option. 2801 2802 * old_user_uuid: Optional[str] --- UUID of the user whose ownership is being transferred to `new_owner_uuid`. You must be an admin to use this option. 2803 2804 * redirect_to_new_user: bool --- If true, authorization attempts for the old user will be redirected to the new user. Default `False`. 2805 """
Transfer ownership of one user’s data to another.
Required parameters:
- new_owner_uuid: str — UUID of the user or group that will take ownership of data owned by the old user.
Optional parameters:
new_user_token: Optional[str] — Valid API token for the user receiving ownership. If you use this option, it takes ownership of data owned by the user making the request.
new_user_uuid: Optional[str] — UUID of the user receiving ownership. You must be an admin to use this option.
old_user_uuid: Optional[str] — UUID of the user whose ownership is being transferred to
new_owner_uuid. You must be an admin to use this option.redirect_to_new_user: bool — If true, authorization attempts for the old user will be redirected to the new user. Default
False.
def
setup( self, *, repo_name: Optional[str] = None, send_notification_email: bool = False, user: Optional[Dict[str, Any]] = None, uuid: Optional[str] = None, vm_uuid: Optional[str] = None) -> ArvadosAPIRequest[User]:
2807 def setup(self, *, repo_name: 'Optional[str]' = None, send_notification_email: 'bool' = False, user: 'Optional[Dict[str, Any]]' = None, uuid: 'Optional[str]' = None, vm_uuid: 'Optional[str]' = None) -> 'ArvadosAPIRequest[User]': 2808 """Convenience method to "fully" set up a user record with a virtual machine login and notification email. 2809 2810 Optional parameters: 2811 2812 * repo_name: Optional[str] --- This parameter is obsolete and ignored. 2813 2814 * send_notification_email: bool --- If true, send an email to the user notifying them they can now access this Arvados cluster. Default `False`. 2815 2816 * user: Optional[Dict[str, Any]] --- Attributes of a new user record to set up. 2817 2818 * uuid: Optional[str] --- UUID of an existing user record to set up. 2819 2820 * vm_uuid: Optional[str] --- If given, setup creates a login link to allow this user to access the Arvados virtual machine with this UUID. 2821 """
Convenience method to “fully” set up a user record with a virtual machine login and notification email.
Optional parameters:
repo_name: Optional[str] — This parameter is obsolete and ignored.
send_notification_email: bool — If true, send an email to the user notifying them they can now access this Arvados cluster. Default
False.user: Optional[Dict[str, Any]] — Attributes of a new user record to set up.
uuid: Optional[str] — UUID of an existing user record to set up.
vm_uuid: Optional[str] — If given, setup creates a login link to allow this user to access the Arvados virtual machine with this UUID.
2823 def system(self) -> 'ArvadosAPIRequest[User]': 2824 """Return this cluster's system ("root") user record."""
Return this cluster’s system ("root") user record.
2826 def unsetup(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2827 """Unset a user's active flag and delete associated records. 2828 2829 Required parameters: 2830 2831 * uuid: str --- The UUID of the User to update. 2832 """
Unset a user’s active flag and delete associated records.
Required parameters:
- uuid: str — The UUID of the User to update.
def
update( self, *, body: Dict[Literal['user'], User], uuid: str, bypass_federation: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[User]:
2834 def update(self, *, body: "Dict[Literal['user'], User]", uuid: 'str', bypass_federation: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2835 """Update attributes of an existing User. 2836 2837 Required parameters: 2838 2839 * body: Dict[Literal['user'], User] --- A dictionary with a single item `'user'`. 2840 Its value is a `User` dictionary defining the attributes to set. 2841 2842 * uuid: str --- The UUID of the User to update. 2843 2844 Optional parameters: 2845 2846 * bypass_federation: bool --- If true, do not try to update the user on any other clusters in the federation, 2847 only the cluster that received the request. 2848 You must be an administrator to use this flag. Default `False`. 2849 2850 * select: Optional[List] --- An array of names of attributes to return in the response. 2851 """
Update attributes of an existing User.
Required parameters:
body: Dict[Literal[’user’], User] — A dictionary with a single item
'user'. Its value is aUserdictionary defining the attributes to set.uuid: str — The UUID of the User to update.
Optional parameters:
bypass_federation: bool — If true, do not try to update the user on any other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
class
VirtualMachine(typing.TypedDict):
2854class VirtualMachine(TypedDict, total=False): 2855 """Arvados virtual machine ("shell node") 2856 2857 This resource stores information about a virtual machine or "shell node" 2858 hosted on this Arvados cluster where users can log in and use preconfigured 2859 Arvados client tools. 2860 2861 This is the dictionary object that represents a single VirtualMachine in Arvados 2862 and is returned by most `VirtualMachines` methods. 2863 The keys of the dictionary are documented below, along with their types. 2864 Not every key may appear in every dictionary returned by an API call. 2865 When a method doesn't return all the data, you can use its `select` parameter 2866 to list the specific keys you need. Refer to the API documentation for details. 2867 """ 2868 etag: 'str' 2869 """Object cache version.""" 2870 uuid: 'str' 2871 """This virtual machine's Arvados UUID, like `zzzzz-2x53u-12345abcde67890`.""" 2872 owner_uuid: 'str' 2873 """The UUID of the user or group that owns this virtual machine.""" 2874 modified_by_user_uuid: 'str' 2875 """The UUID of the user that last updated this virtual machine.""" 2876 modified_at: 'str' 2877 """The time this virtual machine was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2878 hostname: 'str' 2879 """The DNS hostname where users should access this virtual machine.""" 2880 created_at: 'str' 2881 """The time this virtual machine was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
Arvados virtual machine ("shell node")
This resource stores information about a virtual machine or “shell node” hosted on this Arvados cluster where users can log in and use preconfigured Arvados client tools.
This is the dictionary object that represents a single VirtualMachine in Arvados
and is returned by most VirtualMachines methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
class
VirtualMachineList(typing.TypedDict):
2884class VirtualMachineList(TypedDict, total=False): 2885 """A list of VirtualMachine objects. 2886 2887 This is the dictionary object returned when you call `VirtualMachines.list`. 2888 If you just want to iterate all objects that match your search criteria, 2889 consider using `arvados.util.keyset_list_all`. 2890 If you work with this raw object, the keys of the dictionary are documented 2891 below, along with their types. The `items` key maps to a list of matching 2892 `VirtualMachine` objects. 2893 """ 2894 kind: 'str' = 'arvados#virtualMachineList' 2895 """Object type. Always arvados#virtualMachineList.""" 2896 etag: 'str' 2897 """List cache version.""" 2898 items: 'List[VirtualMachine]' 2899 """An array of matching VirtualMachine objects."""
A list of VirtualMachine objects.
This is the dictionary object returned when you call VirtualMachines.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.keyset_list_all.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
VirtualMachine objects.
class
VirtualMachines:
2902class VirtualMachines: 2903 """Methods to query and manipulate Arvados virtual machines""" 2904 2905 def create(self, *, body: "Dict[Literal['virtual_machine'], VirtualMachine]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 2906 """Create a new VirtualMachine. 2907 2908 Required parameters: 2909 2910 * body: Dict[Literal['virtual_machine'], VirtualMachine] --- A dictionary with a single item `'virtual_machine'`. 2911 Its value is a `VirtualMachine` dictionary defining the attributes to set. 2912 2913 Optional parameters: 2914 2915 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2916 2917 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2918 2919 * select: Optional[List] --- An array of names of attributes to return in the response. 2920 """ 2921 2922 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]': 2923 """Delete an existing VirtualMachine. 2924 2925 Required parameters: 2926 2927 * uuid: str --- The UUID of the VirtualMachine to delete. 2928 """ 2929 2930 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 2931 """Get a VirtualMachine record by UUID. 2932 2933 Required parameters: 2934 2935 * uuid: str --- The UUID of the VirtualMachine to return. 2936 2937 Optional parameters: 2938 2939 * select: Optional[List] --- An array of names of attributes to return in the response. 2940 """ 2941 2942 def get_all_logins(self) -> 'ArvadosAPIRequest[VirtualMachine]': 2943 """List login permission links for all virtual machines.""" 2944 2945 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[VirtualMachineList]': 2946 """Retrieve a VirtualMachineList. 2947 2948 This method returns a single page of `VirtualMachine` objects that match your search 2949 criteria. If you just want to iterate all objects that match your search 2950 criteria, consider using `arvados.util.keyset_list_all`. 2951 2952 Optional parameters: 2953 2954 * bypass_federation: bool --- If true, do not return results from other clusters in the 2955 federation, only the cluster that received the request. 2956 You must be an administrator to use this flag. Default `False`. 2957 2958 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2959 2960 * count: str --- A string to determine result counting behavior. Supported values are: 2961 2962 * `"exact"`: The response will include an `items_available` field that 2963 counts the number of objects that matched this search criteria, 2964 including ones not included in `items`. 2965 2966 * `"none"`: The response will not include an `items_avaliable` 2967 field. This improves performance by returning a result as soon as enough 2968 `items` have been loaded for this result. 2969 2970 Default `'exact'`. 2971 2972 * distinct: bool --- If this is true, and multiple objects have the same values 2973 for the attributes that you specify in the `select` parameter, then each unique 2974 set of values will only be returned once in the result set. Default `False`. 2975 2976 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2977 Refer to the [filters reference][] for more information about how to write filters. 2978 2979 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2980 2981 * limit: int --- The maximum number of objects to return in the result. 2982 Note that the API may return fewer results than this if your request hits other 2983 limits set by the administrator. Default `100`. 2984 2985 * offset: int --- Return matching objects starting from this index. 2986 Note that result indexes may change if objects are modified in between a series 2987 of list calls. Default `0`. 2988 2989 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2990 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2991 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2992 2993 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2994 2995 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2996 The keys of this object are attribute names. 2997 Each value is either a single matching value or an array of matching values for that attribute. 2998 The `filters` parameter is more flexible and preferred. 2999 """ 3000 3001 def logins(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]': 3002 """List login permission links for a given virtual machine. 3003 3004 Required parameters: 3005 3006 * uuid: str --- The UUID of the VirtualMachine to query. 3007 """ 3008 3009 def update(self, *, body: "Dict[Literal['virtual_machine'], VirtualMachine]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 3010 """Update attributes of an existing VirtualMachine. 3011 3012 Required parameters: 3013 3014 * body: Dict[Literal['virtual_machine'], VirtualMachine] --- A dictionary with a single item `'virtual_machine'`. 3015 Its value is a `VirtualMachine` dictionary defining the attributes to set. 3016 3017 * uuid: str --- The UUID of the VirtualMachine to update. 3018 3019 Optional parameters: 3020 3021 * select: Optional[List] --- An array of names of attributes to return in the response. 3022 """
Methods to query and manipulate Arvados virtual machines
def
create( self, *, body: Dict[Literal['virtual_machine'], VirtualMachine], cluster_id: Optional[str] = None, ensure_unique_name: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[VirtualMachine]:
2905 def create(self, *, body: "Dict[Literal['virtual_machine'], VirtualMachine]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 2906 """Create a new VirtualMachine. 2907 2908 Required parameters: 2909 2910 * body: Dict[Literal['virtual_machine'], VirtualMachine] --- A dictionary with a single item `'virtual_machine'`. 2911 Its value is a `VirtualMachine` dictionary defining the attributes to set. 2912 2913 Optional parameters: 2914 2915 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2916 2917 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 2918 2919 * select: Optional[List] --- An array of names of attributes to return in the response. 2920 """
Create a new VirtualMachine.
Required parameters:
- body: Dict[Literal[’virtual_machine’], VirtualMachine] — A dictionary with a single item
'virtual_machine'. Its value is aVirtualMachinedictionary defining the attributes to set.
Optional parameters:
cluster_id: Optional[str] — Cluster ID of a federated cluster where this object should be created.
ensure_unique_name: bool — If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
2922 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]': 2923 """Delete an existing VirtualMachine. 2924 2925 Required parameters: 2926 2927 * uuid: str --- The UUID of the VirtualMachine to delete. 2928 """
Delete an existing VirtualMachine.
Required parameters:
- uuid: str — The UUID of the VirtualMachine to delete.
2930 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 2931 """Get a VirtualMachine record by UUID. 2932 2933 Required parameters: 2934 2935 * uuid: str --- The UUID of the VirtualMachine to return. 2936 2937 Optional parameters: 2938 2939 * select: Optional[List] --- An array of names of attributes to return in the response. 2940 """
Get a VirtualMachine record by UUID.
Required parameters:
- uuid: str — The UUID of the VirtualMachine to return.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
2942 def get_all_logins(self) -> 'ArvadosAPIRequest[VirtualMachine]': 2943 """List login permission links for all virtual machines."""
List login permission links for all virtual machines.
def
list( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, limit: int = 100, offset: int = 0, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[VirtualMachineList]:
2945 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[VirtualMachineList]': 2946 """Retrieve a VirtualMachineList. 2947 2948 This method returns a single page of `VirtualMachine` objects that match your search 2949 criteria. If you just want to iterate all objects that match your search 2950 criteria, consider using `arvados.util.keyset_list_all`. 2951 2952 Optional parameters: 2953 2954 * bypass_federation: bool --- If true, do not return results from other clusters in the 2955 federation, only the cluster that received the request. 2956 You must be an administrator to use this flag. Default `False`. 2957 2958 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2959 2960 * count: str --- A string to determine result counting behavior. Supported values are: 2961 2962 * `"exact"`: The response will include an `items_available` field that 2963 counts the number of objects that matched this search criteria, 2964 including ones not included in `items`. 2965 2966 * `"none"`: The response will not include an `items_avaliable` 2967 field. This improves performance by returning a result as soon as enough 2968 `items` have been loaded for this result. 2969 2970 Default `'exact'`. 2971 2972 * distinct: bool --- If this is true, and multiple objects have the same values 2973 for the attributes that you specify in the `select` parameter, then each unique 2974 set of values will only be returned once in the result set. Default `False`. 2975 2976 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2977 Refer to the [filters reference][] for more information about how to write filters. 2978 2979 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2980 2981 * limit: int --- The maximum number of objects to return in the result. 2982 Note that the API may return fewer results than this if your request hits other 2983 limits set by the administrator. Default `100`. 2984 2985 * offset: int --- Return matching objects starting from this index. 2986 Note that result indexes may change if objects are modified in between a series 2987 of list calls. Default `0`. 2988 2989 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2990 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2991 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2992 2993 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2994 2995 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2996 The keys of this object are attribute names. 2997 Each value is either a single matching value or an array of matching values for that attribute. 2998 The `filters` parameter is more flexible and preferred. 2999 """
Retrieve a VirtualMachineList.
This method returns a single page of VirtualMachine objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.keyset_list_all.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
3001 def logins(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]': 3002 """List login permission links for a given virtual machine. 3003 3004 Required parameters: 3005 3006 * uuid: str --- The UUID of the VirtualMachine to query. 3007 """
List login permission links for a given virtual machine.
Required parameters:
- uuid: str — The UUID of the VirtualMachine to query.
def
update( self, *, body: Dict[Literal['virtual_machine'], VirtualMachine], uuid: str, select: Optional[List] = None) -> ArvadosAPIRequest[VirtualMachine]:
3009 def update(self, *, body: "Dict[Literal['virtual_machine'], VirtualMachine]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 3010 """Update attributes of an existing VirtualMachine. 3011 3012 Required parameters: 3013 3014 * body: Dict[Literal['virtual_machine'], VirtualMachine] --- A dictionary with a single item `'virtual_machine'`. 3015 Its value is a `VirtualMachine` dictionary defining the attributes to set. 3016 3017 * uuid: str --- The UUID of the VirtualMachine to update. 3018 3019 Optional parameters: 3020 3021 * select: Optional[List] --- An array of names of attributes to return in the response. 3022 """
Update attributes of an existing VirtualMachine.
Required parameters:
body: Dict[Literal[’virtual_machine’], VirtualMachine] — A dictionary with a single item
'virtual_machine'. Its value is aVirtualMachinedictionary defining the attributes to set.uuid: str — The UUID of the VirtualMachine to update.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
class
Vocabularies:
3025class Vocabularies: 3026 """Methods to query and manipulate Arvados vocabularies""" 3027 3028 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 3029 """Get this cluster's configured vocabulary definition. 3030 3031 Refer to [metadata vocabulary documentation][] for details. 3032 3033 [metadata vocabulary documentation]: https://doc.aravdos.org/admin/metadata-vocabulary.html 3034 """
Methods to query and manipulate Arvados vocabularies
3028 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 3029 """Get this cluster's configured vocabulary definition. 3030 3031 Refer to [metadata vocabulary documentation][] for details. 3032 3033 [metadata vocabulary documentation]: https://doc.aravdos.org/admin/metadata-vocabulary.html 3034 """
Get this cluster’s configured vocabulary definition.
Refer to metadata vocabulary documentation for details.
class
Workflow(typing.TypedDict):
3037class Workflow(TypedDict, total=False): 3038 """Arvados workflow 3039 3040 A workflow contains workflow definition source code that Arvados can execute 3041 along with associated metadata for users. 3042 3043 This is the dictionary object that represents a single Workflow in Arvados 3044 and is returned by most `Workflows` methods. 3045 The keys of the dictionary are documented below, along with their types. 3046 Not every key may appear in every dictionary returned by an API call. 3047 When a method doesn't return all the data, you can use its `select` parameter 3048 to list the specific keys you need. Refer to the API documentation for details. 3049 """ 3050 etag: 'str' 3051 """Object cache version.""" 3052 uuid: 'str' 3053 """This workflow's Arvados UUID, like `zzzzz-7fd4e-12345abcde67890`.""" 3054 owner_uuid: 'str' 3055 """The UUID of the user or group that owns this workflow.""" 3056 created_at: 'str' 3057 """The time this workflow was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 3058 modified_at: 'str' 3059 """The time this workflow was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 3060 modified_by_user_uuid: 'str' 3061 """The UUID of the user that last updated this workflow.""" 3062 name: 'str' 3063 """The name of this workflow assigned by a user.""" 3064 description: 'str' 3065 """A longer HTML description of this workflow assigned by a user. 3066 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 3067 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 3068 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 3069 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 3070 """ 3071 definition: 'str' 3072 """A string with the CWL source of this workflow."""
Arvados workflow
A workflow contains workflow definition source code that Arvados can execute along with associated metadata for users.
This is the dictionary object that represents a single Workflow in Arvados
and is returned by most Workflows methods.
The keys of the dictionary are documented below, along with their types.
Not every key may appear in every dictionary returned by an API call.
When a method doesn’t return all the data, you can use its select parameter
to list the specific keys you need. Refer to the API documentation for details.
created_at: str
The time this workflow was created. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
modified_at: str
The time this workflow was last updated. The string encodes a UTC date and time in ISO 8601 format. Pass this to ciso8601.parse_datetime to build a datetime.datetime.
class
WorkflowList(typing.TypedDict):
3075class WorkflowList(TypedDict, total=False): 3076 """A list of Workflow objects. 3077 3078 This is the dictionary object returned when you call `Workflows.list`. 3079 If you just want to iterate all objects that match your search criteria, 3080 consider using `arvados.util.keyset_list_all`. 3081 If you work with this raw object, the keys of the dictionary are documented 3082 below, along with their types. The `items` key maps to a list of matching 3083 `Workflow` objects. 3084 """ 3085 kind: 'str' = 'arvados#workflowList' 3086 """Object type. Always arvados#workflowList.""" 3087 etag: 'str' 3088 """List cache version.""" 3089 items: 'List[Workflow]' 3090 """An array of matching Workflow objects."""
A list of Workflow objects.
This is the dictionary object returned when you call Workflows.list.
If you just want to iterate all objects that match your search criteria,
consider using arvados.util.keyset_list_all.
If you work with this raw object, the keys of the dictionary are documented
below, along with their types. The items key maps to a list of matching
Workflow objects.
class
Workflows:
3093class Workflows: 3094 """Methods to query and manipulate Arvados workflows""" 3095 3096 def create(self, *, body: "Dict[Literal['workflow'], Workflow]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3097 """Create a new Workflow. 3098 3099 Required parameters: 3100 3101 * body: Dict[Literal['workflow'], Workflow] --- A dictionary with a single item `'workflow'`. 3102 Its value is a `Workflow` dictionary defining the attributes to set. 3103 3104 Optional parameters: 3105 3106 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 3107 3108 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 3109 3110 * select: Optional[List] --- An array of names of attributes to return in the response. 3111 """ 3112 3113 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Workflow]': 3114 """Delete an existing Workflow. 3115 3116 Required parameters: 3117 3118 * uuid: str --- The UUID of the Workflow to delete. 3119 """ 3120 3121 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3122 """Get a Workflow record by UUID. 3123 3124 Required parameters: 3125 3126 * uuid: str --- The UUID of the Workflow to return. 3127 3128 Optional parameters: 3129 3130 * select: Optional[List] --- An array of names of attributes to return in the response. 3131 """ 3132 3133 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[WorkflowList]': 3134 """Retrieve a WorkflowList. 3135 3136 This method returns a single page of `Workflow` objects that match your search 3137 criteria. If you just want to iterate all objects that match your search 3138 criteria, consider using `arvados.util.keyset_list_all`. 3139 3140 Optional parameters: 3141 3142 * bypass_federation: bool --- If true, do not return results from other clusters in the 3143 federation, only the cluster that received the request. 3144 You must be an administrator to use this flag. Default `False`. 3145 3146 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 3147 3148 * count: str --- A string to determine result counting behavior. Supported values are: 3149 3150 * `"exact"`: The response will include an `items_available` field that 3151 counts the number of objects that matched this search criteria, 3152 including ones not included in `items`. 3153 3154 * `"none"`: The response will not include an `items_avaliable` 3155 field. This improves performance by returning a result as soon as enough 3156 `items` have been loaded for this result. 3157 3158 Default `'exact'`. 3159 3160 * distinct: bool --- If this is true, and multiple objects have the same values 3161 for the attributes that you specify in the `select` parameter, then each unique 3162 set of values will only be returned once in the result set. Default `False`. 3163 3164 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 3165 Refer to the [filters reference][] for more information about how to write filters. 3166 3167 [filters reference]: https://doc.arvados.org/api/methods.html#filters 3168 3169 * limit: int --- The maximum number of objects to return in the result. 3170 Note that the API may return fewer results than this if your request hits other 3171 limits set by the administrator. Default `100`. 3172 3173 * offset: int --- Return matching objects starting from this index. 3174 Note that result indexes may change if objects are modified in between a series 3175 of list calls. Default `0`. 3176 3177 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 3178 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 3179 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 3180 3181 * select: Optional[List] --- An array of names of attributes to return from each matching object. 3182 3183 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 3184 The keys of this object are attribute names. 3185 Each value is either a single matching value or an array of matching values for that attribute. 3186 The `filters` parameter is more flexible and preferred. 3187 """ 3188 3189 def update(self, *, body: "Dict[Literal['workflow'], Workflow]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3190 """Update attributes of an existing Workflow. 3191 3192 Required parameters: 3193 3194 * body: Dict[Literal['workflow'], Workflow] --- A dictionary with a single item `'workflow'`. 3195 Its value is a `Workflow` dictionary defining the attributes to set. 3196 3197 * uuid: str --- The UUID of the Workflow to update. 3198 3199 Optional parameters: 3200 3201 * select: Optional[List] --- An array of names of attributes to return in the response. 3202 """
Methods to query and manipulate Arvados workflows
def
create( self, *, body: Dict[Literal['workflow'], Workflow], cluster_id: Optional[str] = None, ensure_unique_name: bool = False, select: Optional[List] = None) -> ArvadosAPIRequest[Workflow]:
3096 def create(self, *, body: "Dict[Literal['workflow'], Workflow]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3097 """Create a new Workflow. 3098 3099 Required parameters: 3100 3101 * body: Dict[Literal['workflow'], Workflow] --- A dictionary with a single item `'workflow'`. 3102 Its value is a `Workflow` dictionary defining the attributes to set. 3103 3104 Optional parameters: 3105 3106 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 3107 3108 * ensure_unique_name: bool --- If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default `False`. 3109 3110 * select: Optional[List] --- An array of names of attributes to return in the response. 3111 """
Create a new Workflow.
Required parameters:
- body: Dict[Literal[’workflow’], Workflow] — A dictionary with a single item
'workflow'. Its value is aWorkflowdictionary defining the attributes to set.
Optional parameters:
cluster_id: Optional[str] — Cluster ID of a federated cluster where this object should be created.
ensure_unique_name: bool — If the given name is already used by this owner, adjust the name to ensure uniqueness instead of returning an error. Default
False.select: Optional[List] — An array of names of attributes to return in the response.
3113 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Workflow]': 3114 """Delete an existing Workflow. 3115 3116 Required parameters: 3117 3118 * uuid: str --- The UUID of the Workflow to delete. 3119 """
Delete an existing Workflow.
Required parameters:
- uuid: str — The UUID of the Workflow to delete.
3121 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3122 """Get a Workflow record by UUID. 3123 3124 Required parameters: 3125 3126 * uuid: str --- The UUID of the Workflow to return. 3127 3128 Optional parameters: 3129 3130 * select: Optional[List] --- An array of names of attributes to return in the response. 3131 """
Get a Workflow record by UUID.
Required parameters:
- uuid: str — The UUID of the Workflow to return.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
def
list( self, *, bypass_federation: bool = False, cluster_id: Optional[str] = None, count: str = 'exact', distinct: bool = False, filters: Optional[List] = None, limit: int = 100, offset: int = 0, order: Optional[List] = None, select: Optional[List] = None, where: Optional[Dict[str, Any]] = None) -> ArvadosAPIRequest[WorkflowList]:
3133 def list(self, *, bypass_federation: 'bool' = False, cluster_id: 'Optional[str]' = None, count: 'str' = 'exact', distinct: 'bool' = False, filters: 'Optional[List]' = None, limit: 'int' = 100, offset: 'int' = 0, order: 'Optional[List]' = None, select: 'Optional[List]' = None, where: 'Optional[Dict[str, Any]]' = None) -> 'ArvadosAPIRequest[WorkflowList]': 3134 """Retrieve a WorkflowList. 3135 3136 This method returns a single page of `Workflow` objects that match your search 3137 criteria. If you just want to iterate all objects that match your search 3138 criteria, consider using `arvados.util.keyset_list_all`. 3139 3140 Optional parameters: 3141 3142 * bypass_federation: bool --- If true, do not return results from other clusters in the 3143 federation, only the cluster that received the request. 3144 You must be an administrator to use this flag. Default `False`. 3145 3146 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 3147 3148 * count: str --- A string to determine result counting behavior. Supported values are: 3149 3150 * `"exact"`: The response will include an `items_available` field that 3151 counts the number of objects that matched this search criteria, 3152 including ones not included in `items`. 3153 3154 * `"none"`: The response will not include an `items_avaliable` 3155 field. This improves performance by returning a result as soon as enough 3156 `items` have been loaded for this result. 3157 3158 Default `'exact'`. 3159 3160 * distinct: bool --- If this is true, and multiple objects have the same values 3161 for the attributes that you specify in the `select` parameter, then each unique 3162 set of values will only be returned once in the result set. Default `False`. 3163 3164 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 3165 Refer to the [filters reference][] for more information about how to write filters. 3166 3167 [filters reference]: https://doc.arvados.org/api/methods.html#filters 3168 3169 * limit: int --- The maximum number of objects to return in the result. 3170 Note that the API may return fewer results than this if your request hits other 3171 limits set by the administrator. Default `100`. 3172 3173 * offset: int --- Return matching objects starting from this index. 3174 Note that result indexes may change if objects are modified in between a series 3175 of list calls. Default `0`. 3176 3177 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 3178 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 3179 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 3180 3181 * select: Optional[List] --- An array of names of attributes to return from each matching object. 3182 3183 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 3184 The keys of this object are attribute names. 3185 Each value is either a single matching value or an array of matching values for that attribute. 3186 The `filters` parameter is more flexible and preferred. 3187 """
Retrieve a WorkflowList.
This method returns a single page of Workflow objects that match your search
criteria. If you just want to iterate all objects that match your search
criteria, consider using arvados.util.keyset_list_all.
Optional parameters:
bypass_federation: bool — If true, do not return results from other clusters in the federation, only the cluster that received the request. You must be an administrator to use this flag. Default
False.cluster_id: Optional[str] — Cluster ID of a federated cluster to return objects from
count: str — A string to determine result counting behavior. Supported values are:
"exact": The response will include anitems_availablefield that counts the number of objects that matched this search criteria, including ones not included initems."none": The response will not include anitems_avaliablefield. This improves performance by returning a result as soon as enoughitemshave been loaded for this result.
Default
'exact'.distinct: bool — If this is true, and multiple objects have the same values for the attributes that you specify in the
selectparameter, then each unique set of values will only be returned once in the result set. DefaultFalse.filters: Optional[List] — Filters to limit which objects are returned by their attributes. Refer to the filters reference for more information about how to write filters.
limit: int — The maximum number of objects to return in the result. Note that the API may return fewer results than this if your request hits other limits set by the administrator. Default
100.offset: int — Return matching objects starting from this index. Note that result indexes may change if objects are modified in between a series of list calls. Default
0.order: Optional[List] — An array of strings to set the order in which matching objects are returned. Each string has the format
<ATTRIBUTE> <DIRECTION>.DIRECTIONcan beascor omitted for ascending, ordescfor descending.select: Optional[List] — An array of names of attributes to return from each matching object.
where: Optional[Dict[str, Any]] — An object to limit which objects are returned by their attributes. The keys of this object are attribute names. Each value is either a single matching value or an array of matching values for that attribute. The
filtersparameter is more flexible and preferred.
def
update( self, *, body: Dict[Literal['workflow'], Workflow], uuid: str, select: Optional[List] = None) -> ArvadosAPIRequest[Workflow]:
3189 def update(self, *, body: "Dict[Literal['workflow'], Workflow]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3190 """Update attributes of an existing Workflow. 3191 3192 Required parameters: 3193 3194 * body: Dict[Literal['workflow'], Workflow] --- A dictionary with a single item `'workflow'`. 3195 Its value is a `Workflow` dictionary defining the attributes to set. 3196 3197 * uuid: str --- The UUID of the Workflow to update. 3198 3199 Optional parameters: 3200 3201 * select: Optional[List] --- An array of names of attributes to return in the response. 3202 """
Update attributes of an existing Workflow.
Required parameters:
body: Dict[Literal[’workflow’], Workflow] — A dictionary with a single item
'workflow'. Its value is aWorkflowdictionary defining the attributes to set.uuid: str — The UUID of the Workflow to update.
Optional parameters:
- select: Optional[List] — An array of names of attributes to return in the response.
class
ArvadosAPIClient(googleapiclient.discovery.Resource):
3205class ArvadosAPIClient(googleapiclient.discovery.Resource): 3206 3207 def api_client_authorizations(self) -> 'ApiClientAuthorizations': 3208 """Return an instance of `ApiClientAuthorizations` to call methods via this client""" 3209 3210 def authorized_keys(self) -> 'AuthorizedKeys': 3211 """Return an instance of `AuthorizedKeys` to call methods via this client""" 3212 3213 def collections(self) -> 'Collections': 3214 """Return an instance of `Collections` to call methods via this client""" 3215 3216 def computed_permissions(self) -> 'ComputedPermissions': 3217 """Return an instance of `ComputedPermissions` to call methods via this client""" 3218 3219 def configs(self) -> 'Configs': 3220 """Return an instance of `Configs` to call methods via this client""" 3221 3222 def container_requests(self) -> 'ContainerRequests': 3223 """Return an instance of `ContainerRequests` to call methods via this client""" 3224 3225 def containers(self) -> 'Containers': 3226 """Return an instance of `Containers` to call methods via this client""" 3227 3228 def groups(self) -> 'Groups': 3229 """Return an instance of `Groups` to call methods via this client""" 3230 3231 def keep_services(self) -> 'KeepServices': 3232 """Return an instance of `KeepServices` to call methods via this client""" 3233 3234 def links(self) -> 'Links': 3235 """Return an instance of `Links` to call methods via this client""" 3236 3237 def logs(self) -> 'Logs': 3238 """Return an instance of `Logs` to call methods via this client""" 3239 3240 def sys(self) -> 'Sys': 3241 """Return an instance of `Sys` to call methods via this client""" 3242 3243 def user_agreements(self) -> 'UserAgreements': 3244 """Return an instance of `UserAgreements` to call methods via this client""" 3245 3246 def users(self) -> 'Users': 3247 """Return an instance of `Users` to call methods via this client""" 3248 3249 def virtual_machines(self) -> 'VirtualMachines': 3250 """Return an instance of `VirtualMachines` to call methods via this client""" 3251 3252 def vocabularies(self) -> 'Vocabularies': 3253 """Return an instance of `Vocabularies` to call methods via this client""" 3254 3255 def workflows(self) -> 'Workflows': 3256 """Return an instance of `Workflows` to call methods via this client"""
A class for interacting with a resource.
3213 def collections(self) -> 'Collections': 3214 """Return an instance of `Collections` to call methods via this client"""
Return an instance of Collections to call methods via this client
3216 def computed_permissions(self) -> 'ComputedPermissions': 3217 """Return an instance of `ComputedPermissions` to call methods via this client"""
Return an instance of ComputedPermissions to call methods via this client
3219 def configs(self) -> 'Configs': 3220 """Return an instance of `Configs` to call methods via this client"""
Return an instance of Configs to call methods via this client
3222 def container_requests(self) -> 'ContainerRequests': 3223 """Return an instance of `ContainerRequests` to call methods via this client"""
Return an instance of ContainerRequests to call methods via this client
3225 def containers(self) -> 'Containers': 3226 """Return an instance of `Containers` to call methods via this client"""
Return an instance of Containers to call methods via this client
3228 def groups(self) -> 'Groups': 3229 """Return an instance of `Groups` to call methods via this client"""
Return an instance of Groups to call methods via this client
3231 def keep_services(self) -> 'KeepServices': 3232 """Return an instance of `KeepServices` to call methods via this client"""
Return an instance of KeepServices to call methods via this client
3234 def links(self) -> 'Links': 3235 """Return an instance of `Links` to call methods via this client"""
Return an instance of Links to call methods via this client
3237 def logs(self) -> 'Logs': 3238 """Return an instance of `Logs` to call methods via this client"""
Return an instance of Logs to call methods via this client
Return an instance of Sys to call methods via this client
3243 def user_agreements(self) -> 'UserAgreements': 3244 """Return an instance of `UserAgreements` to call methods via this client"""
Return an instance of UserAgreements to call methods via this client
3246 def users(self) -> 'Users': 3247 """Return an instance of `Users` to call methods via this client"""
Return an instance of Users to call methods via this client
3249 def virtual_machines(self) -> 'VirtualMachines': 3250 """Return an instance of `VirtualMachines` to call methods via this client"""
Return an instance of VirtualMachines to call methods via this client
3252 def vocabularies(self) -> 'Vocabularies': 3253 """Return an instance of `Vocabularies` to call methods via this client"""
Return an instance of Vocabularies to call methods via this client
3255 def workflows(self) -> 'Workflows': 3256 """Return an instance of `Workflows` to call methods via this client"""
Return an instance of Workflows to call methods via this client
Inherited Members
- googleapiclient.discovery.Resource
- Resource
- close