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, 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 * select: Optional[List] --- An array of names of attributes to return in the response. 549 """ 550 551 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 552 """Delete an existing Collection. 553 554 Required parameters: 555 556 * uuid: str --- The UUID of the Collection to delete. 557 """ 558 559 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 560 """Get a Collection record by UUID. 561 562 Required parameters: 563 564 * uuid: str --- The UUID of the Collection to return. 565 566 Optional parameters: 567 568 * include_trash: bool --- Show collection even if its `is_trashed` attribute is true. Default `False`. 569 570 * select: Optional[List] --- An array of names of attributes to return in the response. 571 """ 572 573 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]': 574 """Retrieve a CollectionList. 575 576 This method returns a single page of `Collection` objects that match your search 577 criteria. If you just want to iterate all objects that match your search 578 criteria, consider using `arvados.util.keyset_list_all`. 579 580 Optional parameters: 581 582 * bypass_federation: bool --- If true, do not return results from other clusters in the 583 federation, only the cluster that received the request. 584 You must be an administrator to use this flag. Default `False`. 585 586 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 587 588 * count: str --- A string to determine result counting behavior. Supported values are: 589 590 * `"exact"`: The response will include an `items_available` field that 591 counts the number of objects that matched this search criteria, 592 including ones not included in `items`. 593 594 * `"none"`: The response will not include an `items_avaliable` 595 field. This improves performance by returning a result as soon as enough 596 `items` have been loaded for this result. 597 598 Default `'exact'`. 599 600 * distinct: bool --- If this is true, and multiple objects have the same values 601 for the attributes that you specify in the `select` parameter, then each unique 602 set of values will only be returned once in the result set. Default `False`. 603 604 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 605 Refer to the [filters reference][] for more information about how to write filters. 606 607 [filters reference]: https://doc.arvados.org/api/methods.html#filters 608 609 * include_old_versions: bool --- Include past collection versions. Default `False`. 610 611 * include_trash: bool --- Include collections whose `is_trashed` attribute is true. Default `False`. 612 613 * limit: int --- The maximum number of objects to return in the result. 614 Note that the API may return fewer results than this if your request hits other 615 limits set by the administrator. Default `100`. 616 617 * offset: int --- Return matching objects starting from this index. 618 Note that result indexes may change if objects are modified in between a series 619 of list calls. Default `0`. 620 621 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 622 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 623 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 624 625 * select: Optional[List] --- An array of names of attributes to return from each matching object. 626 627 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 628 The keys of this object are attribute names. 629 Each value is either a single matching value or an array of matching values for that attribute. 630 The `filters` parameter is more flexible and preferred. 631 """ 632 633 def provenance(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 634 """Detail the provenance of a given collection. 635 636 Required parameters: 637 638 * uuid: str --- The UUID of the Collection to query. 639 """ 640 641 def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 642 """Trash a collection. 643 644 Required parameters: 645 646 * uuid: str --- The UUID of the Collection to update. 647 """ 648 649 def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 650 """Untrash a collection. 651 652 Required parameters: 653 654 * uuid: str --- The UUID of the Collection to update. 655 """ 656 657 def update(self, *, body: "Dict[Literal['collection'], Collection]", uuid: 'str', replace_files: 'Optional[Dict[str, Any]]' = None, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 658 """Update attributes of an existing Collection. 659 660 Required parameters: 661 662 * body: Dict[Literal['collection'], Collection] --- A dictionary with a single item `'collection'`. 663 Its value is a `Collection` dictionary defining the attributes to set. 664 665 * uuid: str --- The UUID of the Collection to update. 666 667 Optional parameters: 668 669 * replace_files: Optional[Dict[str, Any]] --- Add, delete, and replace files and directories with new content 670 and/or content from other collections. Refer to the 671 [replace_files reference][] for details. 672 673 [replace_files reference]: https://doc.arvados.org/api/methods/collections.html#replace_files 674 675 * select: Optional[List] --- An array of names of attributes to return in the response. 676 """ 677 678 def used_by(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 679 """Detail where a given collection has been used. 680 681 Required parameters: 682 683 * uuid: str --- The UUID of the Collection to query. 684 """ 685 686 687class ComputedPermission(TypedDict, total=False): 688 """Arvados computed permission 689 690 Computed permissions do not correspond directly to any Arvados resource, but 691 provide a simple way to query the entire graph of permissions granted to 692 users and groups. 693 694 This is the dictionary object that represents a single ComputedPermission in Arvados 695 and is returned by most `ComputedPermissions` methods. 696 The keys of the dictionary are documented below, along with their types. 697 Not every key may appear in every dictionary returned by an API call. 698 When a method doesn't return all the data, you can use its `select` parameter 699 to list the specific keys you need. Refer to the API documentation for details. 700 """ 701 user_uuid: 'str' 702 """The UUID of the Arvados user who has this permission.""" 703 target_uuid: 'str' 704 """The UUID of the Arvados object the user has access to.""" 705 perm_level: 'str' 706 """A string representing the user's level of access to the target object. 707 Possible values are: 708 709 * `"can_read"` 710 * `"can_write"` 711 * `"can_manage"` 712 """ 713 714 715class ComputedPermissionList(TypedDict, total=False): 716 """A list of ComputedPermission objects. 717 718 This is the dictionary object returned when you call `ComputedPermissions.list`. 719 If you just want to iterate all objects that match your search criteria, 720 consider using `arvados.util.iter_computed_permissions`. 721 If you work with this raw object, the keys of the dictionary are documented 722 below, along with their types. The `items` key maps to a list of matching 723 `ComputedPermission` objects. 724 """ 725 kind: 'str' = 'arvados#computedPermissionList' 726 """Object type. Always arvados#computedPermissionList.""" 727 etag: 'str' 728 """List cache version.""" 729 items: 'List[ComputedPermission]' 730 """An array of matching ComputedPermission objects.""" 731 732 733class ComputedPermissions: 734 """Methods to query and manipulate Arvados computed permissions""" 735 736 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]': 737 """Retrieve a ComputedPermissionList. 738 739 This method returns a single page of `ComputedPermission` objects that match your search 740 criteria. If you just want to iterate all objects that match your search 741 criteria, consider using `arvados.util.iter_computed_permissions`. 742 743 Optional parameters: 744 745 * count: str --- A string to determine result counting behavior. Supported values are: 746 747 * `"exact"`: The response will include an `items_available` field that 748 counts the number of objects that matched this search criteria, 749 including ones not included in `items`. 750 751 * `"none"`: The response will not include an `items_avaliable` 752 field. This improves performance by returning a result as soon as enough 753 `items` have been loaded for this result. 754 755 Default `'exact'`. 756 757 * distinct: bool --- If this is true, and multiple objects have the same values 758 for the attributes that you specify in the `select` parameter, then each unique 759 set of values will only be returned once in the result set. Default `False`. 760 761 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 762 Refer to the [filters reference][] for more information about how to write filters. 763 764 [filters reference]: https://doc.arvados.org/api/methods.html#filters 765 766 * limit: int --- The maximum number of objects to return in the result. 767 Note that the API may return fewer results than this if your request hits other 768 limits set by the administrator. Default `100`. 769 770 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 771 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 772 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 773 774 * select: Optional[List] --- An array of names of attributes to return from each matching object. 775 776 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 777 The keys of this object are attribute names. 778 Each value is either a single matching value or an array of matching values for that attribute. 779 The `filters` parameter is more flexible and preferred. 780 """ 781 782 783class Configs: 784 """Methods to query and manipulate Arvados configs""" 785 786 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 787 """Get this cluster's public configuration settings.""" 788 789 790class ContainerRequest(TypedDict, total=False): 791 """Arvados container request 792 793 A container request represents a user's request that Arvados do some compute 794 work, along with full details about what work should be done. Arvados will 795 attempt to fulfill the request by mapping it to a matching container record, 796 running the work on demand if necessary. 797 798 This is the dictionary object that represents a single ContainerRequest in Arvados 799 and is returned by most `ContainerRequests` methods. 800 The keys of the dictionary are documented below, along with their types. 801 Not every key may appear in every dictionary returned by an API call. 802 When a method doesn't return all the data, you can use its `select` parameter 803 to list the specific keys you need. Refer to the API documentation for details. 804 """ 805 etag: 'str' 806 """Object cache version.""" 807 uuid: 'str' 808 """This container request's Arvados UUID, like `zzzzz-xvhdp-12345abcde67890`.""" 809 owner_uuid: 'str' 810 """The UUID of the user or group that owns this container request.""" 811 created_at: 'str' 812 """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`.""" 813 modified_at: 'str' 814 """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`.""" 815 modified_by_user_uuid: 'str' 816 """The UUID of the user that last updated this container request.""" 817 name: 'str' 818 """The name of this container request assigned by a user.""" 819 description: 'str' 820 """A longer HTML description of this container request assigned by a user. 821 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 822 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 823 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 824 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 825 """ 826 properties: 'Dict[str, Any]' 827 """A hash of arbitrary metadata for this container request. 828 Some keys may be reserved by Arvados or defined by a configured vocabulary. 829 Refer to the [metadata properties reference][] for details. 830 831 [metadata properties reference]: https://doc.arvados.org/api/properties.html 832 """ 833 state: 'str' 834 """A string indicating where this container request is in its lifecycle. 835 Possible values are: 836 837 * `"Uncommitted"` --- The container request has not been finalized and can still be edited. 838 * `"Committed"` --- The container request is ready to be fulfilled. 839 * `"Final"` --- The container request has been fulfilled or cancelled. 840 """ 841 requesting_container_uuid: 'str' 842 """The UUID of the container that created this container request, if any.""" 843 container_uuid: 'str' 844 """The UUID of the container that fulfills this container request, if any.""" 845 container_count_max: 'int' 846 """An integer that defines the maximum number of times Arvados should attempt 847 to dispatch a container to fulfill this container request. 848 """ 849 mounts: 'Dict[str, Any]' 850 """A hash where each key names a directory inside this container, and its 851 value is an object that defines the mount source for that directory. Refer 852 to the [mount types reference][] for details. 853 854 [mount types reference]: https://doc.arvados.org/api/methods/containers.html#mount_types 855 """ 856 runtime_constraints: 'Dict[str, Any]' 857 """A hash that identifies compute resources this container requires to run 858 successfully. See the [runtime constraints reference][] for details. 859 860 [runtime constraints reference]: https://doc.arvados.org/api/methods/containers.html#runtime_constraints 861 """ 862 container_image: 'str' 863 """The portable data hash of the Arvados collection that contains the image 864 to use for this container. 865 """ 866 environment: 'Dict[str, Any]' 867 """A hash of string keys and values that defines the environment variables 868 for the dispatcher to set when it executes this container. 869 """ 870 cwd: 'str' 871 """A string that the defines the working directory that the dispatcher should 872 use when it executes the command inside this container. 873 """ 874 command: 'List' 875 """An array of strings that defines the command that the dispatcher should 876 execute inside this container. 877 """ 878 output_path: 'str' 879 """A string that defines the file or directory path where the command 880 writes output that should be saved from this container. 881 """ 882 priority: 'int' 883 """An integer between 0 and 1000 (inclusive) that represents this container request's 884 scheduling priority. 0 represents a request to be cancelled. Higher 885 values represent higher priority. Refer to the [priority reference][] for details. 886 887 [priority reference]: https://doc.arvados.org/api/methods/container_requests.html#priority 888 """ 889 expires_at: 'str' 890 """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`.""" 891 filters: 'str' 892 """Filters that limit which existing containers are eligible to satisfy this 893 container request. This attribute is not implemented yet and should be null. 894 """ 895 container_count: 'int' 896 """An integer that records how many times Arvados has attempted to dispatch 897 a container to fulfill this container request. 898 """ 899 use_existing: 'bool' 900 """A boolean flag. If set, Arvados may choose to satisfy this container 901 request with an eligible container that already exists. Otherwise, Arvados will 902 satisfy this container request with a newer container, which will usually result 903 in the container running again. 904 """ 905 scheduling_parameters: 'Dict[str, Any]' 906 """A hash of scheduling parameters that should be passed to the underlying 907 dispatcher when this container is run. 908 See the [scheduling parameters reference][] for details. 909 910 [scheduling parameters reference]: https://doc.arvados.org/api/methods/containers.html#scheduling_parameters 911 """ 912 output_uuid: 'str' 913 """The UUID of the Arvados collection that contains output for all the 914 container(s) that were dispatched to fulfill this container request. 915 """ 916 log_uuid: 'str' 917 """The UUID of the Arvados collection that contains logs for all the 918 container(s) that were dispatched to fulfill this container request. 919 """ 920 output_name: 'str' 921 """The name to set on the output collection of this container request.""" 922 output_ttl: 'int' 923 """An integer in seconds. If greater than zero, when an output collection is 924 created for this container request, its `expires_at` attribute will be set this 925 far in the future. 926 """ 927 output_storage_classes: 'List' 928 """An array of strings identifying the storage class(es) that should be set 929 on the output collection of this container request. Storage classes are configured by 930 the cluster administrator. 931 """ 932 output_properties: 'Dict[str, Any]' 933 """A hash of arbitrary metadata to set on the output collection of this container request. 934 Some keys may be reserved by Arvados or defined by a configured vocabulary. 935 Refer to the [metadata properties reference][] for details. 936 937 [metadata properties reference]: https://doc.arvados.org/api/properties.html 938 """ 939 cumulative_cost: 'float' 940 """A float with the estimated cost of all cloud instances used to run 941 container(s) to fulfill this container request and their subrequests. 942 The value is `0` if cost estimation is not available on this cluster. 943 """ 944 output_glob: 'List' 945 """An array of strings of shell-style glob patterns that define which file(s) 946 and subdirectory(ies) under the `output_path` directory should be recorded in 947 the container's final output. Refer to the [glob patterns reference][] for details. 948 949 [glob patterns reference]: https://doc.arvados.org/api/methods/containers.html#glob_patterns 950 """ 951 952 953class ContainerRequestList(TypedDict, total=False): 954 """A list of ContainerRequest objects. 955 956 This is the dictionary object returned when you call `ContainerRequests.list`. 957 If you just want to iterate all objects that match your search criteria, 958 consider using `arvados.util.keyset_list_all`. 959 If you work with this raw object, the keys of the dictionary are documented 960 below, along with their types. The `items` key maps to a list of matching 961 `ContainerRequest` objects. 962 """ 963 kind: 'str' = 'arvados#containerRequestList' 964 """Object type. Always arvados#containerRequestList.""" 965 etag: 'str' 966 """List cache version.""" 967 items: 'List[ContainerRequest]' 968 """An array of matching ContainerRequest objects.""" 969 970 971class ContainerRequests: 972 """Methods to query and manipulate Arvados container requests""" 973 974 def container_status(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]': 975 """Return scheduling details for a container request. 976 977 Required parameters: 978 979 * uuid: str --- The UUID of the container request to query. 980 """ 981 982 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]': 983 """Create a new ContainerRequest. 984 985 Required parameters: 986 987 * body: Dict[Literal['container_request'], ContainerRequest] --- A dictionary with a single item `'container_request'`. 988 Its value is a `ContainerRequest` dictionary defining the attributes to set. 989 990 Optional parameters: 991 992 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 993 994 * 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`. 995 996 * select: Optional[List] --- An array of names of attributes to return in the response. 997 """ 998 999 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]': 1000 """Delete an existing ContainerRequest. 1001 1002 Required parameters: 1003 1004 * uuid: str --- The UUID of the ContainerRequest to delete. 1005 """ 1006 1007 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1008 """Get a ContainerRequest record by UUID. 1009 1010 Required parameters: 1011 1012 * uuid: str --- The UUID of the ContainerRequest to return. 1013 1014 Optional parameters: 1015 1016 * include_trash: bool --- Show container request even if its owner project is trashed. Default `False`. 1017 1018 * select: Optional[List] --- An array of names of attributes to return in the response. 1019 """ 1020 1021 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]': 1022 """Retrieve a ContainerRequestList. 1023 1024 This method returns a single page of `ContainerRequest` objects that match your search 1025 criteria. If you just want to iterate all objects that match your search 1026 criteria, consider using `arvados.util.keyset_list_all`. 1027 1028 Optional parameters: 1029 1030 * bypass_federation: bool --- If true, do not return results from other clusters in the 1031 federation, only the cluster that received the request. 1032 You must be an administrator to use this flag. Default `False`. 1033 1034 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1035 1036 * count: str --- A string to determine result counting behavior. Supported values are: 1037 1038 * `"exact"`: The response will include an `items_available` field that 1039 counts the number of objects that matched this search criteria, 1040 including ones not included in `items`. 1041 1042 * `"none"`: The response will not include an `items_avaliable` 1043 field. This improves performance by returning a result as soon as enough 1044 `items` have been loaded for this result. 1045 1046 Default `'exact'`. 1047 1048 * distinct: bool --- If this is true, and multiple objects have the same values 1049 for the attributes that you specify in the `select` parameter, then each unique 1050 set of values will only be returned once in the result set. Default `False`. 1051 1052 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1053 Refer to the [filters reference][] for more information about how to write filters. 1054 1055 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1056 1057 * include_trash: bool --- Include container requests whose owner project is trashed. Default `False`. 1058 1059 * limit: int --- The maximum number of objects to return in the result. 1060 Note that the API may return fewer results than this if your request hits other 1061 limits set by the administrator. Default `100`. 1062 1063 * offset: int --- Return matching objects starting from this index. 1064 Note that result indexes may change if objects are modified in between a series 1065 of list calls. Default `0`. 1066 1067 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1068 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1069 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1070 1071 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1072 1073 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1074 The keys of this object are attribute names. 1075 Each value is either a single matching value or an array of matching values for that attribute. 1076 The `filters` parameter is more flexible and preferred. 1077 """ 1078 1079 def update(self, *, body: "Dict[Literal['container_request'], ContainerRequest]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1080 """Update attributes of an existing ContainerRequest. 1081 1082 Required parameters: 1083 1084 * body: Dict[Literal['container_request'], ContainerRequest] --- A dictionary with a single item `'container_request'`. 1085 Its value is a `ContainerRequest` dictionary defining the attributes to set. 1086 1087 * uuid: str --- The UUID of the ContainerRequest to update. 1088 1089 Optional parameters: 1090 1091 * select: Optional[List] --- An array of names of attributes to return in the response. 1092 """ 1093 1094 1095class Container(TypedDict, total=False): 1096 """Arvados container record 1097 1098 A container represents compute work that has been or should be dispatched, 1099 along with its results. A container can satisfy one or more container requests. 1100 1101 This is the dictionary object that represents a single Container in Arvados 1102 and is returned by most `Containers` methods. 1103 The keys of the dictionary are documented below, along with their types. 1104 Not every key may appear in every dictionary returned by an API call. 1105 When a method doesn't return all the data, you can use its `select` parameter 1106 to list the specific keys you need. Refer to the API documentation for details. 1107 """ 1108 etag: 'str' 1109 """Object cache version.""" 1110 uuid: 'str' 1111 """This container's Arvados UUID, like `zzzzz-dz642-12345abcde67890`.""" 1112 owner_uuid: 'str' 1113 """The UUID of the user or group that owns this container.""" 1114 created_at: 'str' 1115 """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`.""" 1116 modified_at: 'str' 1117 """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`.""" 1118 modified_by_user_uuid: 'str' 1119 """The UUID of the user that last updated this container.""" 1120 state: 'str' 1121 """A string representing the container's current execution status. Possible 1122 values are: 1123 1124 * `"Queued"` --- This container has not been dispatched yet. 1125 * `"Locked"` --- A dispatcher has claimed this container in preparation to run it. 1126 * `"Running"` --- A dispatcher is running this container. 1127 * `"Cancelled"` --- Container execution has been cancelled by user request. 1128 * `"Complete"` --- A dispatcher ran this container to completion and recorded the results. 1129 """ 1130 started_at: 'str' 1131 """The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1132 finished_at: 'str' 1133 """The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1134 log: 'str' 1135 """The portable data hash of the Arvados collection that contains this 1136 container's logs. 1137 """ 1138 environment: 'Dict[str, Any]' 1139 """A hash of string keys and values that defines the environment variables 1140 for the dispatcher to set when it executes this container. 1141 """ 1142 cwd: 'str' 1143 """A string that the defines the working directory that the dispatcher should 1144 use when it executes the command inside this container. 1145 """ 1146 command: 'List' 1147 """An array of strings that defines the command that the dispatcher should 1148 execute inside this container. 1149 """ 1150 output_path: 'str' 1151 """A string that defines the file or directory path where the command 1152 writes output that should be saved from this container. 1153 """ 1154 mounts: 'Dict[str, Any]' 1155 """A hash where each key names a directory inside this container, and its 1156 value is an object that defines the mount source for that directory. Refer 1157 to the [mount types reference][] for details. 1158 1159 [mount types reference]: https://doc.arvados.org/api/methods/containers.html#mount_types 1160 """ 1161 runtime_constraints: 'Dict[str, Any]' 1162 """A hash that identifies compute resources this container requires to run 1163 successfully. See the [runtime constraints reference][] for details. 1164 1165 [runtime constraints reference]: https://doc.arvados.org/api/methods/containers.html#runtime_constraints 1166 """ 1167 output: 'str' 1168 """The portable data hash of the Arvados collection that contains this 1169 container's output file(s). 1170 """ 1171 container_image: 'str' 1172 """The portable data hash of the Arvados collection that contains the image 1173 to use for this container. 1174 """ 1175 progress: 'float' 1176 """A float between 0.0 and 1.0 (inclusive) that represents the container's 1177 execution progress. This attribute is not implemented yet. 1178 """ 1179 priority: 'int' 1180 """An integer between 0 and 1000 (inclusive) that represents this container's 1181 scheduling priority. 0 represents a request to be cancelled. Higher 1182 values represent higher priority. Refer to the [priority reference][] for details. 1183 1184 [priority reference]: https://doc.arvados.org/api/methods/container_requests.html#priority 1185 """ 1186 exit_code: 'int' 1187 """An integer that records the Unix exit code of the `command` from a 1188 finished container. 1189 """ 1190 auth_uuid: 'str' 1191 """The UUID of the Arvados API client authorization token that a dispatcher 1192 should use to set up this container. This token is automatically created by 1193 Arvados and this attribute automatically assigned unless a container is 1194 created with `runtime_token`. 1195 """ 1196 locked_by_uuid: 'str' 1197 """The UUID of the Arvados API client authorization token that successfully 1198 locked this container in preparation to execute it. 1199 """ 1200 scheduling_parameters: 'Dict[str, Any]' 1201 """A hash of scheduling parameters that should be passed to the underlying 1202 dispatcher when this container is run. 1203 See the [scheduling parameters reference][] for details. 1204 1205 [scheduling parameters reference]: https://doc.arvados.org/api/methods/containers.html#scheduling_parameters 1206 """ 1207 runtime_status: 'Dict[str, Any]' 1208 """A hash with status updates from a running container. 1209 Refer to the [runtime status reference][] for details. 1210 1211 [runtime status reference]: https://doc.arvados.org/api/methods/containers.html#runtime_status 1212 """ 1213 runtime_user_uuid: 'str' 1214 """The UUID of the Arvados user associated with the API client authorization 1215 token used to run this container. 1216 """ 1217 runtime_auth_scopes: 'List' 1218 """The `scopes` from the API client authorization token used to run this container.""" 1219 lock_count: 'int' 1220 """The number of times this container has been locked by a dispatcher. This 1221 may be greater than 1 if a dispatcher locks a container but then execution is 1222 interrupted for any reason. 1223 """ 1224 gateway_address: 'str' 1225 """A string with the address of the Arvados gateway server, in `HOST:PORT` 1226 format. This is for internal use only. 1227 """ 1228 interactive_session_started: 'bool' 1229 """This flag is set true if any user starts an interactive shell inside the 1230 running container. 1231 """ 1232 output_storage_classes: 'List' 1233 """An array of strings identifying the storage class(es) that should be set 1234 on the output collection of this container. Storage classes are configured by 1235 the cluster administrator. 1236 """ 1237 output_properties: 'Dict[str, Any]' 1238 """A hash of arbitrary metadata to set on the output collection of this container. 1239 Some keys may be reserved by Arvados or defined by a configured vocabulary. 1240 Refer to the [metadata properties reference][] for details. 1241 1242 [metadata properties reference]: https://doc.arvados.org/api/properties.html 1243 """ 1244 cost: 'float' 1245 """A float with the estimated cost of the cloud instance used to run this 1246 container. The value is `0` if cost estimation is not available on this cluster. 1247 """ 1248 subrequests_cost: 'float' 1249 """A float with the estimated cost of all cloud instances used to run this 1250 container and all its subrequests. The value is `0` if cost estimation is not 1251 available on this cluster. 1252 """ 1253 output_glob: 'List' 1254 """An array of strings of shell-style glob patterns that define which file(s) 1255 and subdirectory(ies) under the `output_path` directory should be recorded in 1256 the container's final output. Refer to the [glob patterns reference][] for details. 1257 1258 [glob patterns reference]: https://doc.arvados.org/api/methods/containers.html#glob_patterns 1259 """ 1260 1261 1262class ContainerList(TypedDict, total=False): 1263 """A list of Container objects. 1264 1265 This is the dictionary object returned when you call `Containers.list`. 1266 If you just want to iterate all objects that match your search criteria, 1267 consider using `arvados.util.keyset_list_all`. 1268 If you work with this raw object, the keys of the dictionary are documented 1269 below, along with their types. The `items` key maps to a list of matching 1270 `Container` objects. 1271 """ 1272 kind: 'str' = 'arvados#containerList' 1273 """Object type. Always arvados#containerList.""" 1274 etag: 'str' 1275 """List cache version.""" 1276 items: 'List[Container]' 1277 """An array of matching Container objects.""" 1278 1279 1280class Containers: 1281 """Methods to query and manipulate Arvados containers""" 1282 1283 def auth(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1284 """Get the API client authorization token associated with this container. 1285 1286 Required parameters: 1287 1288 * uuid: str --- The UUID of the Container to query. 1289 """ 1290 1291 def create(self, *, body: "Dict[Literal['container'], Container]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1292 """Create a new Container. 1293 1294 Required parameters: 1295 1296 * body: Dict[Literal['container'], Container] --- A dictionary with a single item `'container'`. 1297 Its value is a `Container` dictionary defining the attributes to set. 1298 1299 Optional parameters: 1300 1301 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1302 1303 * 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`. 1304 1305 * select: Optional[List] --- An array of names of attributes to return in the response. 1306 """ 1307 1308 def current(self) -> 'ArvadosAPIRequest[Container]': 1309 """Return the container record associated with the API token authorizing this request.""" 1310 1311 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1312 """Delete an existing Container. 1313 1314 Required parameters: 1315 1316 * uuid: str --- The UUID of the Container to delete. 1317 """ 1318 1319 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1320 """Get a Container record by UUID. 1321 1322 Required parameters: 1323 1324 * uuid: str --- The UUID of the Container to return. 1325 1326 Optional parameters: 1327 1328 * select: Optional[List] --- An array of names of attributes to return in the response. 1329 """ 1330 1331 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]': 1332 """Retrieve a ContainerList. 1333 1334 This method returns a single page of `Container` objects that match your search 1335 criteria. If you just want to iterate all objects that match your search 1336 criteria, consider using `arvados.util.keyset_list_all`. 1337 1338 Optional parameters: 1339 1340 * bypass_federation: bool --- If true, do not return results from other clusters in the 1341 federation, only the cluster that received the request. 1342 You must be an administrator to use this flag. Default `False`. 1343 1344 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1345 1346 * count: str --- A string to determine result counting behavior. Supported values are: 1347 1348 * `"exact"`: The response will include an `items_available` field that 1349 counts the number of objects that matched this search criteria, 1350 including ones not included in `items`. 1351 1352 * `"none"`: The response will not include an `items_avaliable` 1353 field. This improves performance by returning a result as soon as enough 1354 `items` have been loaded for this result. 1355 1356 Default `'exact'`. 1357 1358 * distinct: bool --- If this is true, and multiple objects have the same values 1359 for the attributes that you specify in the `select` parameter, then each unique 1360 set of values will only be returned once in the result set. Default `False`. 1361 1362 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1363 Refer to the [filters reference][] for more information about how to write filters. 1364 1365 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1366 1367 * limit: int --- The maximum number of objects to return in the result. 1368 Note that the API may return fewer results than this if your request hits other 1369 limits set by the administrator. Default `100`. 1370 1371 * offset: int --- Return matching objects starting from this index. 1372 Note that result indexes may change if objects are modified in between a series 1373 of list calls. Default `0`. 1374 1375 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1376 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1377 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1378 1379 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1380 1381 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1382 The keys of this object are attribute names. 1383 Each value is either a single matching value or an array of matching values for that attribute. 1384 The `filters` parameter is more flexible and preferred. 1385 """ 1386 1387 def lock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1388 """Lock a container (for a dispatcher to begin running it). 1389 1390 Required parameters: 1391 1392 * uuid: str --- The UUID of the Container to update. 1393 """ 1394 1395 def secret_mounts(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1396 """Return secret mount information for the container associated with the API token authorizing this request. 1397 1398 Required parameters: 1399 1400 * uuid: str --- The UUID of the Container to query. 1401 """ 1402 1403 def unlock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1404 """Unlock a container (for a dispatcher to stop running it). 1405 1406 Required parameters: 1407 1408 * uuid: str --- The UUID of the Container to update. 1409 """ 1410 1411 def update(self, *, body: "Dict[Literal['container'], Container]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1412 """Update attributes of an existing Container. 1413 1414 Required parameters: 1415 1416 * body: Dict[Literal['container'], Container] --- A dictionary with a single item `'container'`. 1417 Its value is a `Container` dictionary defining the attributes to set. 1418 1419 * uuid: str --- The UUID of the Container to update. 1420 1421 Optional parameters: 1422 1423 * select: Optional[List] --- An array of names of attributes to return in the response. 1424 """ 1425 1426 def update_priority(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1427 """Recalculate and return the priority of a given container. 1428 1429 Required parameters: 1430 1431 * uuid: str --- The UUID of the Container to update. 1432 """ 1433 1434 1435class Group(TypedDict, total=False): 1436 """Arvados group 1437 1438 Groups provide a way to organize users or data together, depending on their 1439 `group_class`. 1440 1441 This is the dictionary object that represents a single Group in Arvados 1442 and is returned by most `Groups` methods. 1443 The keys of the dictionary are documented below, along with their types. 1444 Not every key may appear in every dictionary returned by an API call. 1445 When a method doesn't return all the data, you can use its `select` parameter 1446 to list the specific keys you need. Refer to the API documentation for details. 1447 """ 1448 etag: 'str' 1449 """Object cache version.""" 1450 uuid: 'str' 1451 """This group's Arvados UUID, like `zzzzz-j7d0g-12345abcde67890`.""" 1452 owner_uuid: 'str' 1453 """The UUID of the user or group that owns this group.""" 1454 created_at: 'str' 1455 """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`.""" 1456 modified_by_user_uuid: 'str' 1457 """The UUID of the user that last updated this group.""" 1458 modified_at: 'str' 1459 """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`.""" 1460 name: 'str' 1461 """The name of this group assigned by a user.""" 1462 description: 'str' 1463 """A longer HTML description of this group assigned by a user. 1464 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 1465 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 1466 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 1467 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 1468 """ 1469 group_class: 'str' 1470 """A string representing which type of group this is. One of: 1471 1472 * `"filter"` --- A virtual project whose contents are selected dynamically by filters. 1473 * `"project"` --- An Arvados project that can contain collections, 1474 container records, workflows, and subprojects. 1475 * `"role"` --- A group of users that can be granted permissions in Arvados. 1476 """ 1477 trash_at: 'str' 1478 """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`.""" 1479 is_trashed: 'bool' 1480 """A boolean flag to indicate whether or not this group is trashed.""" 1481 delete_at: 'str' 1482 """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`.""" 1483 properties: 'Dict[str, Any]' 1484 """A hash of arbitrary metadata for this group. 1485 Some keys may be reserved by Arvados or defined by a configured vocabulary. 1486 Refer to the [metadata properties reference][] for details. 1487 1488 [metadata properties reference]: https://doc.arvados.org/api/properties.html 1489 """ 1490 frozen_by_uuid: 'str' 1491 """The UUID of the user that has frozen this group, if any. Frozen projects 1492 cannot have their contents or metadata changed, even by admins. 1493 """ 1494 1495 1496class GroupList(TypedDict, total=False): 1497 """A list of Group objects. 1498 1499 This is the dictionary object returned when you call `Groups.list`. 1500 If you just want to iterate all objects that match your search criteria, 1501 consider using `arvados.util.keyset_list_all`. 1502 If you work with this raw object, the keys of the dictionary are documented 1503 below, along with their types. The `items` key maps to a list of matching 1504 `Group` objects. 1505 """ 1506 kind: 'str' = 'arvados#groupList' 1507 """Object type. Always arvados#groupList.""" 1508 etag: 'str' 1509 """List cache version.""" 1510 items: 'List[Group]' 1511 """An array of matching Group objects.""" 1512 1513 1514class Groups: 1515 """Methods to query and manipulate Arvados groups""" 1516 1517 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]': 1518 """List objects that belong to a group. 1519 1520 Optional parameters: 1521 1522 * bypass_federation: bool --- If true, do not return results from other clusters in the 1523 federation, only the cluster that received the request. 1524 You must be an administrator to use this flag. Default `False`. 1525 1526 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1527 1528 * count: str --- A string to determine result counting behavior. Supported values are: 1529 1530 * `"exact"`: The response will include an `items_available` field that 1531 counts the number of objects that matched this search criteria, 1532 including ones not included in `items`. 1533 1534 * `"none"`: The response will not include an `items_avaliable` 1535 field. This improves performance by returning a result as soon as enough 1536 `items` have been loaded for this result. 1537 1538 Default `'exact'`. 1539 1540 * distinct: bool --- If this is true, and multiple objects have the same values 1541 for the attributes that you specify in the `select` parameter, then each unique 1542 set of values will only be returned once in the result set. Default `False`. 1543 1544 * exclude_home_project: bool --- If true, exclude contents of the user's home project from the listing. 1545 Calling this method with this flag set is how clients enumerate objects shared 1546 with the current user. Default `False`. 1547 1548 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1549 Refer to the [filters reference][] for more information about how to write filters. 1550 1551 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1552 1553 * include: Optional[List] --- An array of referenced objects to include in the `included` field of the response. Supported values in the array are: 1554 1555 * `"container_uuid"` 1556 * `"owner_uuid"` 1557 1558 1559 1560 * include_old_versions: bool --- If true, include past versions of collections in the listing. Default `False`. 1561 1562 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1563 1564 * limit: int --- The maximum number of objects to return in the result. 1565 Note that the API may return fewer results than this if your request hits other 1566 limits set by the administrator. Default `100`. 1567 1568 * offset: int --- Return matching objects starting from this index. 1569 Note that result indexes may change if objects are modified in between a series 1570 of list calls. Default `0`. 1571 1572 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1573 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1574 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1575 1576 * recursive: bool --- If true, include contents from child groups recursively. Default `False`. 1577 1578 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1579 1580 * uuid: str --- If given, limit the listing to objects owned by the 1581 user or group with this UUID. Default `''`. 1582 1583 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1584 The keys of this object are attribute names. 1585 Each value is either a single matching value or an array of matching values for that attribute. 1586 The `filters` parameter is more flexible and preferred. 1587 """ 1588 1589 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]': 1590 """Create a new Group. 1591 1592 Required parameters: 1593 1594 * body: Dict[Literal['group'], Group] --- A dictionary with a single item `'group'`. 1595 Its value is a `Group` dictionary defining the attributes to set. 1596 1597 Optional parameters: 1598 1599 * async: bool --- If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default `False`. 1600 1601 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1602 1603 * 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`. 1604 1605 * select: Optional[List] --- An array of names of attributes to return in the response. 1606 """ 1607 1608 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1609 """Delete an existing Group. 1610 1611 Required parameters: 1612 1613 * uuid: str --- The UUID of the Group to delete. 1614 """ 1615 1616 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1617 """Get a Group record by UUID. 1618 1619 Required parameters: 1620 1621 * uuid: str --- The UUID of the Group to return. 1622 1623 Optional parameters: 1624 1625 * include_trash: bool --- Return group/project even if its `is_trashed` attribute is true. Default `False`. 1626 1627 * select: Optional[List] --- An array of names of attributes to return in the response. 1628 """ 1629 1630 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]': 1631 """Retrieve a GroupList. 1632 1633 This method returns a single page of `Group` objects that match your search 1634 criteria. If you just want to iterate all objects that match your search 1635 criteria, consider using `arvados.util.keyset_list_all`. 1636 1637 Optional parameters: 1638 1639 * bypass_federation: bool --- If true, do not return results from other clusters in the 1640 federation, only the cluster that received the request. 1641 You must be an administrator to use this flag. Default `False`. 1642 1643 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1644 1645 * count: str --- A string to determine result counting behavior. Supported values are: 1646 1647 * `"exact"`: The response will include an `items_available` field that 1648 counts the number of objects that matched this search criteria, 1649 including ones not included in `items`. 1650 1651 * `"none"`: The response will not include an `items_avaliable` 1652 field. This improves performance by returning a result as soon as enough 1653 `items` have been loaded for this result. 1654 1655 Default `'exact'`. 1656 1657 * distinct: bool --- If this is true, and multiple objects have the same values 1658 for the attributes that you specify in the `select` parameter, then each unique 1659 set of values will only be returned once in the result set. Default `False`. 1660 1661 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1662 Refer to the [filters reference][] for more information about how to write filters. 1663 1664 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1665 1666 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1667 1668 * limit: int --- The maximum number of objects to return in the result. 1669 Note that the API may return fewer results than this if your request hits other 1670 limits set by the administrator. Default `100`. 1671 1672 * offset: int --- Return matching objects starting from this index. 1673 Note that result indexes may change if objects are modified in between a series 1674 of list calls. Default `0`. 1675 1676 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1677 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1678 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1679 1680 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1681 1682 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1683 The keys of this object are attribute names. 1684 Each value is either a single matching value or an array of matching values for that attribute. 1685 The `filters` parameter is more flexible and preferred. 1686 """ 1687 1688 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]': 1689 """List groups that the current user can access via permission links. 1690 1691 Optional parameters: 1692 1693 * bypass_federation: bool --- If true, do not return results from other clusters in the 1694 federation, only the cluster that received the request. 1695 You must be an administrator to use this flag. Default `False`. 1696 1697 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1698 1699 * count: str --- A string to determine result counting behavior. Supported values are: 1700 1701 * `"exact"`: The response will include an `items_available` field that 1702 counts the number of objects that matched this search criteria, 1703 including ones not included in `items`. 1704 1705 * `"none"`: The response will not include an `items_avaliable` 1706 field. This improves performance by returning a result as soon as enough 1707 `items` have been loaded for this result. 1708 1709 Default `'exact'`. 1710 1711 * distinct: bool --- If this is true, and multiple objects have the same values 1712 for the attributes that you specify in the `select` parameter, then each unique 1713 set of values will only be returned once in the result set. Default `False`. 1714 1715 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1716 Refer to the [filters reference][] for more information about how to write filters. 1717 1718 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1719 1720 * include: Optional[str] --- A string naming referenced objects to include in the `included` field of the response. Supported values are: 1721 1722 * `"owner_uuid"` 1723 1724 1725 1726 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1727 1728 * limit: int --- The maximum number of objects to return in the result. 1729 Note that the API may return fewer results than this if your request hits other 1730 limits set by the administrator. Default `100`. 1731 1732 * offset: int --- Return matching objects starting from this index. 1733 Note that result indexes may change if objects are modified in between a series 1734 of list calls. Default `0`. 1735 1736 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1737 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1738 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1739 1740 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1741 1742 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1743 The keys of this object are attribute names. 1744 Each value is either a single matching value or an array of matching values for that attribute. 1745 The `filters` parameter is more flexible and preferred. 1746 """ 1747 1748 def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1749 """Trash a group. 1750 1751 Required parameters: 1752 1753 * uuid: str --- The UUID of the Group to update. 1754 """ 1755 1756 def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1757 """Untrash a group. 1758 1759 Required parameters: 1760 1761 * uuid: str --- The UUID of the Group to update. 1762 """ 1763 1764 def update(self, *, body: "Dict[Literal['group'], Group]", uuid: 'str', async_: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1765 """Update attributes of an existing Group. 1766 1767 Required parameters: 1768 1769 * body: Dict[Literal['group'], Group] --- A dictionary with a single item `'group'`. 1770 Its value is a `Group` dictionary defining the attributes to set. 1771 1772 * uuid: str --- The UUID of the Group to update. 1773 1774 Optional parameters: 1775 1776 * async: bool --- If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default `False`. 1777 1778 * select: Optional[List] --- An array of names of attributes to return in the response. 1779 """ 1780 1781 1782class KeepService(TypedDict, total=False): 1783 """Arvados Keep service 1784 1785 This resource stores information about a single Keep service in this Arvados 1786 cluster that clients can contact to retrieve and store data. 1787 1788 This is the dictionary object that represents a single KeepService in Arvados 1789 and is returned by most `KeepServices` methods. 1790 The keys of the dictionary are documented below, along with their types. 1791 Not every key may appear in every dictionary returned by an API call. 1792 When a method doesn't return all the data, you can use its `select` parameter 1793 to list the specific keys you need. Refer to the API documentation for details. 1794 """ 1795 etag: 'str' 1796 """Object cache version.""" 1797 uuid: 'str' 1798 """This Keep service's Arvados UUID, like `zzzzz-bi6l4-12345abcde67890`.""" 1799 owner_uuid: 'str' 1800 """The UUID of the user or group that owns this Keep service.""" 1801 modified_by_user_uuid: 'str' 1802 """The UUID of the user that last updated this Keep service.""" 1803 modified_at: 'str' 1804 """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`.""" 1805 service_host: 'str' 1806 """The DNS hostname of this Keep service.""" 1807 service_port: 'int' 1808 """The TCP port where this Keep service listens.""" 1809 service_ssl_flag: 'bool' 1810 """A boolean flag that indicates whether or not this Keep service uses TLS/SSL.""" 1811 service_type: 'str' 1812 """A string that describes which type of Keep service this is. One of: 1813 1814 * `"disk"` --- A service that stores blocks on a local filesystem. 1815 * `"blob"` --- A service that stores blocks in a cloud object store. 1816 * `"proxy"` --- A keepproxy service. 1817 """ 1818 created_at: 'str' 1819 """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`.""" 1820 read_only: 'bool' 1821 """A boolean flag. If set, this Keep service does not accept requests to write data 1822 blocks; it only serves blocks it already has. 1823 """ 1824 1825 1826class KeepServiceList(TypedDict, total=False): 1827 """A list of KeepService objects. 1828 1829 This is the dictionary object returned when you call `KeepServices.list`. 1830 If you just want to iterate all objects that match your search criteria, 1831 consider using `arvados.util.keyset_list_all`. 1832 If you work with this raw object, the keys of the dictionary are documented 1833 below, along with their types. The `items` key maps to a list of matching 1834 `KeepService` objects. 1835 """ 1836 kind: 'str' = 'arvados#keepServiceList' 1837 """Object type. Always arvados#keepServiceList.""" 1838 etag: 'str' 1839 """List cache version.""" 1840 items: 'List[KeepService]' 1841 """An array of matching KeepService objects.""" 1842 1843 1844class KeepServices: 1845 """Methods to query and manipulate Arvados keep services""" 1846 1847 def accessible(self) -> 'ArvadosAPIRequest[KeepService]': 1848 """List Keep services that the current client can access.""" 1849 1850 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]': 1851 """Create a new KeepService. 1852 1853 Required parameters: 1854 1855 * body: Dict[Literal['keep_service'], KeepService] --- A dictionary with a single item `'keep_service'`. 1856 Its value is a `KeepService` dictionary defining the attributes to set. 1857 1858 Optional parameters: 1859 1860 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1861 1862 * 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`. 1863 1864 * select: Optional[List] --- An array of names of attributes to return in the response. 1865 """ 1866 1867 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[KeepService]': 1868 """Delete an existing KeepService. 1869 1870 Required parameters: 1871 1872 * uuid: str --- The UUID of the KeepService to delete. 1873 """ 1874 1875 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1876 """Get a KeepService record by UUID. 1877 1878 Required parameters: 1879 1880 * uuid: str --- The UUID of the KeepService to return. 1881 1882 Optional parameters: 1883 1884 * select: Optional[List] --- An array of names of attributes to return in the response. 1885 """ 1886 1887 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]': 1888 """Retrieve a KeepServiceList. 1889 1890 This method returns a single page of `KeepService` objects that match your search 1891 criteria. If you just want to iterate all objects that match your search 1892 criteria, consider using `arvados.util.keyset_list_all`. 1893 1894 Optional parameters: 1895 1896 * bypass_federation: bool --- If true, do not return results from other clusters in the 1897 federation, only the cluster that received the request. 1898 You must be an administrator to use this flag. Default `False`. 1899 1900 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1901 1902 * count: str --- A string to determine result counting behavior. Supported values are: 1903 1904 * `"exact"`: The response will include an `items_available` field that 1905 counts the number of objects that matched this search criteria, 1906 including ones not included in `items`. 1907 1908 * `"none"`: The response will not include an `items_avaliable` 1909 field. This improves performance by returning a result as soon as enough 1910 `items` have been loaded for this result. 1911 1912 Default `'exact'`. 1913 1914 * distinct: bool --- If this is true, and multiple objects have the same values 1915 for the attributes that you specify in the `select` parameter, then each unique 1916 set of values will only be returned once in the result set. Default `False`. 1917 1918 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1919 Refer to the [filters reference][] for more information about how to write filters. 1920 1921 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1922 1923 * limit: int --- The maximum number of objects to return in the result. 1924 Note that the API may return fewer results than this if your request hits other 1925 limits set by the administrator. Default `100`. 1926 1927 * offset: int --- Return matching objects starting from this index. 1928 Note that result indexes may change if objects are modified in between a series 1929 of list calls. Default `0`. 1930 1931 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1932 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1933 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1934 1935 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1936 1937 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1938 The keys of this object are attribute names. 1939 Each value is either a single matching value or an array of matching values for that attribute. 1940 The `filters` parameter is more flexible and preferred. 1941 """ 1942 1943 def update(self, *, body: "Dict[Literal['keep_service'], KeepService]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1944 """Update attributes of an existing KeepService. 1945 1946 Required parameters: 1947 1948 * body: Dict[Literal['keep_service'], KeepService] --- A dictionary with a single item `'keep_service'`. 1949 Its value is a `KeepService` dictionary defining the attributes to set. 1950 1951 * uuid: str --- The UUID of the KeepService to update. 1952 1953 Optional parameters: 1954 1955 * select: Optional[List] --- An array of names of attributes to return in the response. 1956 """ 1957 1958 1959class Link(TypedDict, total=False): 1960 """Arvados object link 1961 1962 A link provides a way to define relationships between Arvados objects, 1963 depending on their `link_class`. 1964 1965 This is the dictionary object that represents a single Link in Arvados 1966 and is returned by most `Links` methods. 1967 The keys of the dictionary are documented below, along with their types. 1968 Not every key may appear in every dictionary returned by an API call. 1969 When a method doesn't return all the data, you can use its `select` parameter 1970 to list the specific keys you need. Refer to the API documentation for details. 1971 """ 1972 etag: 'str' 1973 """Object cache version.""" 1974 uuid: 'str' 1975 """This link's Arvados UUID, like `zzzzz-o0j2j-12345abcde67890`.""" 1976 owner_uuid: 'str' 1977 """The UUID of the user or group that owns this link.""" 1978 created_at: 'str' 1979 """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`.""" 1980 modified_by_user_uuid: 'str' 1981 """The UUID of the user that last updated this link.""" 1982 modified_at: 'str' 1983 """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`.""" 1984 tail_uuid: 'str' 1985 """The UUID of the Arvados object that is the target of this relationship.""" 1986 link_class: 'str' 1987 """A string that defines which kind of link this is. One of: 1988 1989 * `"permission"` --- This link grants a permission to the user or group 1990 referenced by `head_uuid` to the object referenced by `tail_uuid`. The 1991 access level is set by `name`. 1992 * `"star"` --- This link represents a "favorite." The user referenced 1993 by `head_uuid` wants quick access to the object referenced by `tail_uuid`. 1994 * `"tag"` --- This link represents an unstructured metadata tag. The object 1995 referenced by `tail_uuid` has the tag defined by `name`. 1996 """ 1997 name: 'str' 1998 """The primary value of this link. For `"permission"` links, this is one of 1999 `"can_read"`, `"can_write"`, or `"can_manage"`. 2000 """ 2001 head_uuid: 'str' 2002 """The UUID of the Arvados object that is the originator or actor in this 2003 relationship. May be null. 2004 """ 2005 properties: 'Dict[str, Any]' 2006 """A hash of arbitrary metadata for this link. 2007 Some keys may be reserved by Arvados or defined by a configured vocabulary. 2008 Refer to the [metadata properties reference][] for details. 2009 2010 [metadata properties reference]: https://doc.arvados.org/api/properties.html 2011 """ 2012 2013 2014class LinkList(TypedDict, total=False): 2015 """A list of Link objects. 2016 2017 This is the dictionary object returned when you call `Links.list`. 2018 If you just want to iterate all objects that match your search criteria, 2019 consider using `arvados.util.keyset_list_all`. 2020 If you work with this raw object, the keys of the dictionary are documented 2021 below, along with their types. The `items` key maps to a list of matching 2022 `Link` objects. 2023 """ 2024 kind: 'str' = 'arvados#linkList' 2025 """Object type. Always arvados#linkList.""" 2026 etag: 'str' 2027 """List cache version.""" 2028 items: 'List[Link]' 2029 """An array of matching Link objects.""" 2030 2031 2032class Links: 2033 """Methods to query and manipulate Arvados links""" 2034 2035 def create(self, *, body: "Dict[Literal['link'], Link]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2036 """Create a new Link. 2037 2038 Required parameters: 2039 2040 * body: Dict[Literal['link'], Link] --- A dictionary with a single item `'link'`. 2041 Its value is a `Link` dictionary defining the attributes to set. 2042 2043 Optional parameters: 2044 2045 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2046 2047 * 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`. 2048 2049 * select: Optional[List] --- An array of names of attributes to return in the response. 2050 """ 2051 2052 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]': 2053 """Delete an existing Link. 2054 2055 Required parameters: 2056 2057 * uuid: str --- The UUID of the Link to delete. 2058 """ 2059 2060 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2061 """Get a Link record by UUID. 2062 2063 Required parameters: 2064 2065 * uuid: str --- The UUID of the Link to return. 2066 2067 Optional parameters: 2068 2069 * select: Optional[List] --- An array of names of attributes to return in the response. 2070 """ 2071 2072 def get_permissions(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]': 2073 """List permissions granted on an Arvados object. 2074 2075 Required parameters: 2076 2077 * uuid: str --- The UUID of the Link to query. 2078 """ 2079 2080 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]': 2081 """Retrieve a LinkList. 2082 2083 This method returns a single page of `Link` objects that match your search 2084 criteria. If you just want to iterate all objects that match your search 2085 criteria, consider using `arvados.util.keyset_list_all`. 2086 2087 Optional parameters: 2088 2089 * bypass_federation: bool --- If true, do not return results from other clusters in the 2090 federation, only the cluster that received the request. 2091 You must be an administrator to use this flag. Default `False`. 2092 2093 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2094 2095 * count: str --- A string to determine result counting behavior. Supported values are: 2096 2097 * `"exact"`: The response will include an `items_available` field that 2098 counts the number of objects that matched this search criteria, 2099 including ones not included in `items`. 2100 2101 * `"none"`: The response will not include an `items_avaliable` 2102 field. This improves performance by returning a result as soon as enough 2103 `items` have been loaded for this result. 2104 2105 Default `'exact'`. 2106 2107 * distinct: bool --- If this is true, and multiple objects have the same values 2108 for the attributes that you specify in the `select` parameter, then each unique 2109 set of values will only be returned once in the result set. Default `False`. 2110 2111 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2112 Refer to the [filters reference][] for more information about how to write filters. 2113 2114 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2115 2116 * limit: int --- The maximum number of objects to return in the result. 2117 Note that the API may return fewer results than this if your request hits other 2118 limits set by the administrator. Default `100`. 2119 2120 * offset: int --- Return matching objects starting from this index. 2121 Note that result indexes may change if objects are modified in between a series 2122 of list calls. Default `0`. 2123 2124 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2125 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2126 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2127 2128 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2129 2130 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2131 The keys of this object are attribute names. 2132 Each value is either a single matching value or an array of matching values for that attribute. 2133 The `filters` parameter is more flexible and preferred. 2134 """ 2135 2136 def update(self, *, body: "Dict[Literal['link'], Link]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2137 """Update attributes of an existing Link. 2138 2139 Required parameters: 2140 2141 * body: Dict[Literal['link'], Link] --- A dictionary with a single item `'link'`. 2142 Its value is a `Link` dictionary defining the attributes to set. 2143 2144 * uuid: str --- The UUID of the Link to update. 2145 2146 Optional parameters: 2147 2148 * select: Optional[List] --- An array of names of attributes to return in the response. 2149 """ 2150 2151 2152class Log(TypedDict, total=False): 2153 """Arvados log record 2154 2155 This resource represents a single log record about an event in this Arvados 2156 cluster. Some individual Arvados services create log records. Users can also 2157 create custom logs. 2158 2159 This is the dictionary object that represents a single Log in Arvados 2160 and is returned by most `Logs` methods. 2161 The keys of the dictionary are documented below, along with their types. 2162 Not every key may appear in every dictionary returned by an API call. 2163 When a method doesn't return all the data, you can use its `select` parameter 2164 to list the specific keys you need. Refer to the API documentation for details. 2165 """ 2166 etag: 'str' 2167 """Object cache version.""" 2168 id: 'int' 2169 """The serial number of this log. You can use this in filters to query logs 2170 that were created before/after another. 2171 """ 2172 uuid: 'str' 2173 """This log's Arvados UUID, like `zzzzz-57u5n-12345abcde67890`.""" 2174 owner_uuid: 'str' 2175 """The UUID of the user or group that owns this log.""" 2176 modified_by_user_uuid: 'str' 2177 """The UUID of the user that last updated this log.""" 2178 object_uuid: 'str' 2179 """The UUID of the Arvados object that this log pertains to, such as a user 2180 or container. 2181 """ 2182 event_at: 'str' 2183 """The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2184 event_type: 'str' 2185 """An arbitrary short string that classifies what type of log this is.""" 2186 summary: 'str' 2187 """A text string that describes the logged event. This is the primary 2188 attribute for simple logs. 2189 """ 2190 properties: 'Dict[str, Any]' 2191 """A hash of arbitrary metadata for this log. 2192 Some keys may be reserved by Arvados or defined by a configured vocabulary. 2193 Refer to the [metadata properties reference][] for details. 2194 2195 [metadata properties reference]: https://doc.arvados.org/api/properties.html 2196 """ 2197 created_at: 'str' 2198 """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`.""" 2199 modified_at: 'str' 2200 """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`.""" 2201 object_owner_uuid: 'str' 2202 """The `owner_uuid` of the object referenced by `object_uuid` at the time 2203 this log was created. 2204 """ 2205 2206 2207class LogList(TypedDict, total=False): 2208 """A list of Log objects. 2209 2210 This is the dictionary object returned when you call `Logs.list`. 2211 If you just want to iterate all objects that match your search criteria, 2212 consider using `arvados.util.keyset_list_all`. 2213 If you work with this raw object, the keys of the dictionary are documented 2214 below, along with their types. The `items` key maps to a list of matching 2215 `Log` objects. 2216 """ 2217 kind: 'str' = 'arvados#logList' 2218 """Object type. Always arvados#logList.""" 2219 etag: 'str' 2220 """List cache version.""" 2221 items: 'List[Log]' 2222 """An array of matching Log objects.""" 2223 2224 2225class Logs: 2226 """Methods to query and manipulate Arvados logs""" 2227 2228 def create(self, *, body: "Dict[Literal['log'], Log]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2229 """Create a new Log. 2230 2231 Required parameters: 2232 2233 * body: Dict[Literal['log'], Log] --- A dictionary with a single item `'log'`. 2234 Its value is a `Log` dictionary defining the attributes to set. 2235 2236 Optional parameters: 2237 2238 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2239 2240 * 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`. 2241 2242 * select: Optional[List] --- An array of names of attributes to return in the response. 2243 """ 2244 2245 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Log]': 2246 """Delete an existing Log. 2247 2248 Required parameters: 2249 2250 * uuid: str --- The UUID of the Log to delete. 2251 """ 2252 2253 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2254 """Get a Log record by UUID. 2255 2256 Required parameters: 2257 2258 * uuid: str --- The UUID of the Log to return. 2259 2260 Optional parameters: 2261 2262 * select: Optional[List] --- An array of names of attributes to return in the response. 2263 """ 2264 2265 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]': 2266 """Retrieve a LogList. 2267 2268 This method returns a single page of `Log` objects that match your search 2269 criteria. If you just want to iterate all objects that match your search 2270 criteria, consider using `arvados.util.keyset_list_all`. 2271 2272 Optional parameters: 2273 2274 * bypass_federation: bool --- If true, do not return results from other clusters in the 2275 federation, only the cluster that received the request. 2276 You must be an administrator to use this flag. Default `False`. 2277 2278 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2279 2280 * count: str --- A string to determine result counting behavior. Supported values are: 2281 2282 * `"exact"`: The response will include an `items_available` field that 2283 counts the number of objects that matched this search criteria, 2284 including ones not included in `items`. 2285 2286 * `"none"`: The response will not include an `items_avaliable` 2287 field. This improves performance by returning a result as soon as enough 2288 `items` have been loaded for this result. 2289 2290 Default `'exact'`. 2291 2292 * distinct: bool --- If this is true, and multiple objects have the same values 2293 for the attributes that you specify in the `select` parameter, then each unique 2294 set of values will only be returned once in the result set. Default `False`. 2295 2296 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2297 Refer to the [filters reference][] for more information about how to write filters. 2298 2299 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2300 2301 * limit: int --- The maximum number of objects to return in the result. 2302 Note that the API may return fewer results than this if your request hits other 2303 limits set by the administrator. Default `100`. 2304 2305 * offset: int --- Return matching objects starting from this index. 2306 Note that result indexes may change if objects are modified in between a series 2307 of list calls. Default `0`. 2308 2309 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2310 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2311 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2312 2313 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2314 2315 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2316 The keys of this object are attribute names. 2317 Each value is either a single matching value or an array of matching values for that attribute. 2318 The `filters` parameter is more flexible and preferred. 2319 """ 2320 2321 def update(self, *, body: "Dict[Literal['log'], Log]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2322 """Update attributes of an existing Log. 2323 2324 Required parameters: 2325 2326 * body: Dict[Literal['log'], Log] --- A dictionary with a single item `'log'`. 2327 Its value is a `Log` dictionary defining the attributes to set. 2328 2329 * uuid: str --- The UUID of the Log to update. 2330 2331 Optional parameters: 2332 2333 * select: Optional[List] --- An array of names of attributes to return in the response. 2334 """ 2335 2336 2337class Sys: 2338 """Methods to query and manipulate Arvados sys""" 2339 2340 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 2341 """Run scheduled data trash and sweep operations across this cluster's Keep services.""" 2342 2343 2344class UserAgreement(TypedDict, total=False): 2345 """Arvados user agreement 2346 2347 A user agreement is a collection with terms that users must agree to before 2348 they can use this Arvados cluster. 2349 2350 This is the dictionary object that represents a single UserAgreement in Arvados 2351 and is returned by most `UserAgreements` methods. 2352 The keys of the dictionary are documented below, along with their types. 2353 Not every key may appear in every dictionary returned by an API call. 2354 When a method doesn't return all the data, you can use its `select` parameter 2355 to list the specific keys you need. Refer to the API documentation for details. 2356 """ 2357 etag: 'str' 2358 """Object cache version.""" 2359 owner_uuid: 'str' 2360 """The UUID of the user or group that owns this user agreement.""" 2361 created_at: 'str' 2362 """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`.""" 2363 modified_by_user_uuid: 'str' 2364 """The UUID of the user that last updated this user agreement.""" 2365 modified_at: 'str' 2366 """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`.""" 2367 portable_data_hash: 'str' 2368 """The portable data hash of this user agreement. This string provides a unique 2369 and stable reference to these contents. 2370 """ 2371 replication_desired: 'int' 2372 """The number of copies that should be made for data in this user agreement.""" 2373 replication_confirmed_at: 'str' 2374 """The last time the cluster confirmed that it met `replication_confirmed` 2375 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`. 2376 """ 2377 replication_confirmed: 'int' 2378 """The number of copies of data in this user agreement that the cluster has confirmed 2379 exist in storage. 2380 """ 2381 uuid: 'str' 2382 """This user agreement's Arvados UUID, like `zzzzz-gv0sa-12345abcde67890`.""" 2383 manifest_text: 'str' 2384 """The manifest text that describes how files are constructed from data blocks 2385 in this user agreement. Refer to the [manifest format][] reference for details. 2386 2387 [manifest format]: https://doc.arvados.org/architecture/manifest-format.html 2388 """ 2389 name: 'str' 2390 """The name of this user agreement assigned by a user.""" 2391 description: 'str' 2392 """A longer HTML description of this user agreement assigned by a user. 2393 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 2394 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 2395 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 2396 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 2397 """ 2398 properties: 'Dict[str, Any]' 2399 """A hash of arbitrary metadata for this user agreement. 2400 Some keys may be reserved by Arvados or defined by a configured vocabulary. 2401 Refer to the [metadata properties reference][] for details. 2402 2403 [metadata properties reference]: https://doc.arvados.org/api/properties.html 2404 """ 2405 delete_at: 'str' 2406 """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`.""" 2407 trash_at: 'str' 2408 """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`.""" 2409 is_trashed: 'bool' 2410 """A boolean flag to indicate whether or not this user agreement is trashed.""" 2411 storage_classes_desired: 'List' 2412 """An array of strings identifying the storage class(es) that should be used 2413 for data in this user agreement. Storage classes are configured by the cluster administrator. 2414 """ 2415 storage_classes_confirmed: 'List' 2416 """An array of strings identifying the storage class(es) the cluster has 2417 confirmed have a copy of this user agreement's data. 2418 """ 2419 storage_classes_confirmed_at: 'str' 2420 """The last time the cluster confirmed that data was stored on the storage 2421 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`. 2422 """ 2423 current_version_uuid: 'str' 2424 """The UUID of the current version of this user agreement.""" 2425 version: 'int' 2426 """An integer that counts which version of a user agreement this record 2427 represents. Refer to [collection versioning][] for details. This attribute is 2428 read-only. 2429 2430 [collection versioning]: https://doc.arvados.org/user/topics/collection-versioning.html 2431 """ 2432 preserve_version: 'bool' 2433 """A boolean flag to indicate whether this specific version of this user agreement 2434 should be persisted in cluster storage. 2435 """ 2436 file_count: 'int' 2437 """The number of files represented in this user agreement's `manifest_text`. 2438 This attribute is read-only. 2439 """ 2440 file_size_total: 'int' 2441 """The total size in bytes of files represented in this user agreement's `manifest_text`. 2442 This attribute is read-only. 2443 """ 2444 2445 2446class UserAgreementList(TypedDict, total=False): 2447 """A list of UserAgreement objects. 2448 2449 This is the dictionary object returned when you call `UserAgreements.list`. 2450 If you just want to iterate all objects that match your search criteria, 2451 consider using `arvados.util.keyset_list_all`. 2452 If you work with this raw object, the keys of the dictionary are documented 2453 below, along with their types. The `items` key maps to a list of matching 2454 `UserAgreement` objects. 2455 """ 2456 kind: 'str' = 'arvados#userAgreementList' 2457 """Object type. Always arvados#userAgreementList.""" 2458 etag: 'str' 2459 """List cache version.""" 2460 items: 'List[UserAgreement]' 2461 """An array of matching UserAgreement objects.""" 2462 2463 2464class UserAgreements: 2465 """Methods to query and manipulate Arvados user agreements""" 2466 2467 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]': 2468 """Create a new UserAgreement. 2469 2470 Required parameters: 2471 2472 * body: Dict[Literal['user_agreement'], UserAgreement] --- A dictionary with a single item `'user_agreement'`. 2473 Its value is a `UserAgreement` dictionary defining the attributes to set. 2474 2475 Optional parameters: 2476 2477 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2478 2479 * 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`. 2480 2481 * select: Optional[List] --- An array of names of attributes to return in the response. 2482 """ 2483 2484 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[UserAgreement]': 2485 """Delete an existing UserAgreement. 2486 2487 Required parameters: 2488 2489 * uuid: str --- The UUID of the UserAgreement to delete. 2490 """ 2491 2492 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2493 """Get a UserAgreement record by UUID. 2494 2495 Required parameters: 2496 2497 * uuid: str --- The UUID of the UserAgreement to return. 2498 2499 Optional parameters: 2500 2501 * select: Optional[List] --- An array of names of attributes to return in the response. 2502 """ 2503 2504 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]': 2505 """Retrieve a UserAgreementList. 2506 2507 This method returns a single page of `UserAgreement` objects that match your search 2508 criteria. If you just want to iterate all objects that match your search 2509 criteria, consider using `arvados.util.keyset_list_all`. 2510 2511 Optional parameters: 2512 2513 * bypass_federation: bool --- If true, do not return results from other clusters in the 2514 federation, only the cluster that received the request. 2515 You must be an administrator to use this flag. Default `False`. 2516 2517 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2518 2519 * count: str --- A string to determine result counting behavior. Supported values are: 2520 2521 * `"exact"`: The response will include an `items_available` field that 2522 counts the number of objects that matched this search criteria, 2523 including ones not included in `items`. 2524 2525 * `"none"`: The response will not include an `items_avaliable` 2526 field. This improves performance by returning a result as soon as enough 2527 `items` have been loaded for this result. 2528 2529 Default `'exact'`. 2530 2531 * distinct: bool --- If this is true, and multiple objects have the same values 2532 for the attributes that you specify in the `select` parameter, then each unique 2533 set of values will only be returned once in the result set. Default `False`. 2534 2535 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2536 Refer to the [filters reference][] for more information about how to write filters. 2537 2538 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2539 2540 * limit: int --- The maximum number of objects to return in the result. 2541 Note that the API may return fewer results than this if your request hits other 2542 limits set by the administrator. Default `100`. 2543 2544 * offset: int --- Return matching objects starting from this index. 2545 Note that result indexes may change if objects are modified in between a series 2546 of list calls. Default `0`. 2547 2548 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2549 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2550 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2551 2552 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2553 2554 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2555 The keys of this object are attribute names. 2556 Each value is either a single matching value or an array of matching values for that attribute. 2557 The `filters` parameter is more flexible and preferred. 2558 """ 2559 2560 def sign(self) -> 'ArvadosAPIRequest[UserAgreement]': 2561 """Create a signature link from the current user for a given user agreement.""" 2562 2563 def signatures(self) -> 'ArvadosAPIRequest[UserAgreement]': 2564 """List all user agreement signature links from a user.""" 2565 2566 def update(self, *, body: "Dict[Literal['user_agreement'], UserAgreement]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2567 """Update attributes of an existing UserAgreement. 2568 2569 Required parameters: 2570 2571 * body: Dict[Literal['user_agreement'], UserAgreement] --- A dictionary with a single item `'user_agreement'`. 2572 Its value is a `UserAgreement` dictionary defining the attributes to set. 2573 2574 * uuid: str --- The UUID of the UserAgreement to update. 2575 2576 Optional parameters: 2577 2578 * select: Optional[List] --- An array of names of attributes to return in the response. 2579 """ 2580 2581 2582class User(TypedDict, total=False): 2583 """Arvados user 2584 2585 A user represents a single individual or role who may be authorized to access 2586 this Arvados cluster. 2587 2588 This is the dictionary object that represents a single User in Arvados 2589 and is returned by most `Users` methods. 2590 The keys of the dictionary are documented below, along with their types. 2591 Not every key may appear in every dictionary returned by an API call. 2592 When a method doesn't return all the data, you can use its `select` parameter 2593 to list the specific keys you need. Refer to the API documentation for details. 2594 """ 2595 etag: 'str' 2596 """Object cache version.""" 2597 uuid: 'str' 2598 """This user's Arvados UUID, like `zzzzz-tpzed-12345abcde67890`.""" 2599 owner_uuid: 'str' 2600 """The UUID of the user or group that owns this user.""" 2601 created_at: 'str' 2602 """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`.""" 2603 modified_by_user_uuid: 'str' 2604 """The UUID of the user that last updated this user.""" 2605 modified_at: 'str' 2606 """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`.""" 2607 email: 'str' 2608 """This user's email address.""" 2609 first_name: 'str' 2610 """This user's first name.""" 2611 last_name: 'str' 2612 """This user's last name.""" 2613 identity_url: 'str' 2614 """A URL that represents this user with the cluster's identity provider.""" 2615 is_admin: 'bool' 2616 """A boolean flag. If set, this user is an administrator of the Arvados 2617 cluster, and automatically passes most permissions checks. 2618 """ 2619 prefs: 'Dict[str, Any]' 2620 """A hash that stores cluster-wide user preferences.""" 2621 is_active: 'bool' 2622 """A boolean flag. If unset, this user is not permitted to make any Arvados 2623 API requests. 2624 """ 2625 username: 'str' 2626 """This user's Unix username on virtual machines.""" 2627 2628 2629class UserList(TypedDict, total=False): 2630 """A list of User objects. 2631 2632 This is the dictionary object returned when you call `Users.list`. 2633 If you just want to iterate all objects that match your search criteria, 2634 consider using `arvados.util.keyset_list_all`. 2635 If you work with this raw object, the keys of the dictionary are documented 2636 below, along with their types. The `items` key maps to a list of matching 2637 `User` objects. 2638 """ 2639 kind: 'str' = 'arvados#userList' 2640 """Object type. Always arvados#userList.""" 2641 etag: 'str' 2642 """List cache version.""" 2643 items: 'List[User]' 2644 """An array of matching User objects.""" 2645 2646 2647class Users: 2648 """Methods to query and manipulate Arvados users""" 2649 2650 def activate(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2651 """Set the `is_active` flag on a user record. 2652 2653 Required parameters: 2654 2655 * uuid: str --- The UUID of the User to update. 2656 """ 2657 2658 def create(self, *, body: "Dict[Literal['user'], User]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2659 """Create a new User. 2660 2661 Required parameters: 2662 2663 * body: Dict[Literal['user'], User] --- A dictionary with a single item `'user'`. 2664 Its value is a `User` dictionary defining the attributes to set. 2665 2666 Optional parameters: 2667 2668 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2669 2670 * 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`. 2671 2672 * select: Optional[List] --- An array of names of attributes to return in the response. 2673 """ 2674 2675 def current(self) -> 'ArvadosAPIRequest[User]': 2676 """Return the user record associated with the API token authorizing this request.""" 2677 2678 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2679 """Delete an existing User. 2680 2681 Required parameters: 2682 2683 * uuid: str --- The UUID of the User to delete. 2684 """ 2685 2686 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2687 """Get a User record by UUID. 2688 2689 Required parameters: 2690 2691 * uuid: str --- The UUID of the User to return. 2692 2693 Optional parameters: 2694 2695 * select: Optional[List] --- An array of names of attributes to return in the response. 2696 """ 2697 2698 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]': 2699 """Retrieve a UserList. 2700 2701 This method returns a single page of `User` objects that match your search 2702 criteria. If you just want to iterate all objects that match your search 2703 criteria, consider using `arvados.util.keyset_list_all`. 2704 2705 Optional parameters: 2706 2707 * bypass_federation: bool --- If true, do not return results from other clusters in the 2708 federation, only the cluster that received the request. 2709 You must be an administrator to use this flag. Default `False`. 2710 2711 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2712 2713 * count: str --- A string to determine result counting behavior. Supported values are: 2714 2715 * `"exact"`: The response will include an `items_available` field that 2716 counts the number of objects that matched this search criteria, 2717 including ones not included in `items`. 2718 2719 * `"none"`: The response will not include an `items_avaliable` 2720 field. This improves performance by returning a result as soon as enough 2721 `items` have been loaded for this result. 2722 2723 Default `'exact'`. 2724 2725 * distinct: bool --- If this is true, and multiple objects have the same values 2726 for the attributes that you specify in the `select` parameter, then each unique 2727 set of values will only be returned once in the result set. Default `False`. 2728 2729 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2730 Refer to the [filters reference][] for more information about how to write filters. 2731 2732 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2733 2734 * limit: int --- The maximum number of objects to return in the result. 2735 Note that the API may return fewer results than this if your request hits other 2736 limits set by the administrator. Default `100`. 2737 2738 * offset: int --- Return matching objects starting from this index. 2739 Note that result indexes may change if objects are modified in between a series 2740 of list calls. Default `0`. 2741 2742 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2743 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2744 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2745 2746 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2747 2748 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2749 The keys of this object are attribute names. 2750 Each value is either a single matching value or an array of matching values for that attribute. 2751 The `filters` parameter is more flexible and preferred. 2752 """ 2753 2754 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]': 2755 """Transfer ownership of one user's data to another. 2756 2757 Required parameters: 2758 2759 * new_owner_uuid: str --- UUID of the user or group that will take ownership of data owned by the old user. 2760 2761 Optional parameters: 2762 2763 * 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. 2764 2765 * new_user_uuid: Optional[str] --- UUID of the user receiving ownership. You must be an admin to use this option. 2766 2767 * 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. 2768 2769 * redirect_to_new_user: bool --- If true, authorization attempts for the old user will be redirected to the new user. Default `False`. 2770 """ 2771 2772 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]': 2773 """Convenience method to "fully" set up a user record with a virtual machine login and notification email. 2774 2775 Optional parameters: 2776 2777 * repo_name: Optional[str] --- This parameter is obsolete and ignored. 2778 2779 * send_notification_email: bool --- If true, send an email to the user notifying them they can now access this Arvados cluster. Default `False`. 2780 2781 * user: Optional[Dict[str, Any]] --- Attributes of a new user record to set up. 2782 2783 * uuid: Optional[str] --- UUID of an existing user record to set up. 2784 2785 * vm_uuid: Optional[str] --- If given, setup creates a login link to allow this user to access the Arvados virtual machine with this UUID. 2786 """ 2787 2788 def system(self) -> 'ArvadosAPIRequest[User]': 2789 """Return this cluster's system ("root") user record.""" 2790 2791 def unsetup(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2792 """Unset a user's active flag and delete associated records. 2793 2794 Required parameters: 2795 2796 * uuid: str --- The UUID of the User to update. 2797 """ 2798 2799 def update(self, *, body: "Dict[Literal['user'], User]", uuid: 'str', bypass_federation: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2800 """Update attributes of an existing User. 2801 2802 Required parameters: 2803 2804 * body: Dict[Literal['user'], User] --- A dictionary with a single item `'user'`. 2805 Its value is a `User` dictionary defining the attributes to set. 2806 2807 * uuid: str --- The UUID of the User to update. 2808 2809 Optional parameters: 2810 2811 * bypass_federation: bool --- If true, do not try to update the user on any other clusters in the federation, 2812 only the cluster that received the request. 2813 You must be an administrator to use this flag. Default `False`. 2814 2815 * select: Optional[List] --- An array of names of attributes to return in the response. 2816 """ 2817 2818 2819class VirtualMachine(TypedDict, total=False): 2820 """Arvados virtual machine ("shell node") 2821 2822 This resource stores information about a virtual machine or "shell node" 2823 hosted on this Arvados cluster where users can log in and use preconfigured 2824 Arvados client tools. 2825 2826 This is the dictionary object that represents a single VirtualMachine in Arvados 2827 and is returned by most `VirtualMachines` methods. 2828 The keys of the dictionary are documented below, along with their types. 2829 Not every key may appear in every dictionary returned by an API call. 2830 When a method doesn't return all the data, you can use its `select` parameter 2831 to list the specific keys you need. Refer to the API documentation for details. 2832 """ 2833 etag: 'str' 2834 """Object cache version.""" 2835 uuid: 'str' 2836 """This virtual machine's Arvados UUID, like `zzzzz-2x53u-12345abcde67890`.""" 2837 owner_uuid: 'str' 2838 """The UUID of the user or group that owns this virtual machine.""" 2839 modified_by_user_uuid: 'str' 2840 """The UUID of the user that last updated this virtual machine.""" 2841 modified_at: 'str' 2842 """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`.""" 2843 hostname: 'str' 2844 """The DNS hostname where users should access this virtual machine.""" 2845 created_at: 'str' 2846 """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`.""" 2847 2848 2849class VirtualMachineList(TypedDict, total=False): 2850 """A list of VirtualMachine objects. 2851 2852 This is the dictionary object returned when you call `VirtualMachines.list`. 2853 If you just want to iterate all objects that match your search criteria, 2854 consider using `arvados.util.keyset_list_all`. 2855 If you work with this raw object, the keys of the dictionary are documented 2856 below, along with their types. The `items` key maps to a list of matching 2857 `VirtualMachine` objects. 2858 """ 2859 kind: 'str' = 'arvados#virtualMachineList' 2860 """Object type. Always arvados#virtualMachineList.""" 2861 etag: 'str' 2862 """List cache version.""" 2863 items: 'List[VirtualMachine]' 2864 """An array of matching VirtualMachine objects.""" 2865 2866 2867class VirtualMachines: 2868 """Methods to query and manipulate Arvados virtual machines""" 2869 2870 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]': 2871 """Create a new VirtualMachine. 2872 2873 Required parameters: 2874 2875 * body: Dict[Literal['virtual_machine'], VirtualMachine] --- A dictionary with a single item `'virtual_machine'`. 2876 Its value is a `VirtualMachine` dictionary defining the attributes to set. 2877 2878 Optional parameters: 2879 2880 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2881 2882 * 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`. 2883 2884 * select: Optional[List] --- An array of names of attributes to return in the response. 2885 """ 2886 2887 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]': 2888 """Delete an existing VirtualMachine. 2889 2890 Required parameters: 2891 2892 * uuid: str --- The UUID of the VirtualMachine to delete. 2893 """ 2894 2895 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 2896 """Get a VirtualMachine record by UUID. 2897 2898 Required parameters: 2899 2900 * uuid: str --- The UUID of the VirtualMachine to return. 2901 2902 Optional parameters: 2903 2904 * select: Optional[List] --- An array of names of attributes to return in the response. 2905 """ 2906 2907 def get_all_logins(self) -> 'ArvadosAPIRequest[VirtualMachine]': 2908 """List login permission links for all virtual machines.""" 2909 2910 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]': 2911 """Retrieve a VirtualMachineList. 2912 2913 This method returns a single page of `VirtualMachine` objects that match your search 2914 criteria. If you just want to iterate all objects that match your search 2915 criteria, consider using `arvados.util.keyset_list_all`. 2916 2917 Optional parameters: 2918 2919 * bypass_federation: bool --- If true, do not return results from other clusters in the 2920 federation, only the cluster that received the request. 2921 You must be an administrator to use this flag. Default `False`. 2922 2923 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2924 2925 * count: str --- A string to determine result counting behavior. Supported values are: 2926 2927 * `"exact"`: The response will include an `items_available` field that 2928 counts the number of objects that matched this search criteria, 2929 including ones not included in `items`. 2930 2931 * `"none"`: The response will not include an `items_avaliable` 2932 field. This improves performance by returning a result as soon as enough 2933 `items` have been loaded for this result. 2934 2935 Default `'exact'`. 2936 2937 * distinct: bool --- If this is true, and multiple objects have the same values 2938 for the attributes that you specify in the `select` parameter, then each unique 2939 set of values will only be returned once in the result set. Default `False`. 2940 2941 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2942 Refer to the [filters reference][] for more information about how to write filters. 2943 2944 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2945 2946 * limit: int --- The maximum number of objects to return in the result. 2947 Note that the API may return fewer results than this if your request hits other 2948 limits set by the administrator. Default `100`. 2949 2950 * offset: int --- Return matching objects starting from this index. 2951 Note that result indexes may change if objects are modified in between a series 2952 of list calls. Default `0`. 2953 2954 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2955 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2956 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2957 2958 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2959 2960 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2961 The keys of this object are attribute names. 2962 Each value is either a single matching value or an array of matching values for that attribute. 2963 The `filters` parameter is more flexible and preferred. 2964 """ 2965 2966 def logins(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]': 2967 """List login permission links for a given virtual machine. 2968 2969 Required parameters: 2970 2971 * uuid: str --- The UUID of the VirtualMachine to query. 2972 """ 2973 2974 def update(self, *, body: "Dict[Literal['virtual_machine'], VirtualMachine]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 2975 """Update attributes of an existing VirtualMachine. 2976 2977 Required parameters: 2978 2979 * body: Dict[Literal['virtual_machine'], VirtualMachine] --- A dictionary with a single item `'virtual_machine'`. 2980 Its value is a `VirtualMachine` dictionary defining the attributes to set. 2981 2982 * uuid: str --- The UUID of the VirtualMachine to update. 2983 2984 Optional parameters: 2985 2986 * select: Optional[List] --- An array of names of attributes to return in the response. 2987 """ 2988 2989 2990class Vocabularies: 2991 """Methods to query and manipulate Arvados vocabularies""" 2992 2993 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 2994 """Get this cluster's configured vocabulary definition. 2995 2996 Refer to [metadata vocabulary documentation][] for details. 2997 2998 [metadata vocabulary documentation]: https://doc.aravdos.org/admin/metadata-vocabulary.html 2999 """ 3000 3001 3002class Workflow(TypedDict, total=False): 3003 """Arvados workflow 3004 3005 A workflow contains workflow definition source code that Arvados can execute 3006 along with associated metadata for users. 3007 3008 This is the dictionary object that represents a single Workflow in Arvados 3009 and is returned by most `Workflows` methods. 3010 The keys of the dictionary are documented below, along with their types. 3011 Not every key may appear in every dictionary returned by an API call. 3012 When a method doesn't return all the data, you can use its `select` parameter 3013 to list the specific keys you need. Refer to the API documentation for details. 3014 """ 3015 etag: 'str' 3016 """Object cache version.""" 3017 uuid: 'str' 3018 """This workflow's Arvados UUID, like `zzzzz-7fd4e-12345abcde67890`.""" 3019 owner_uuid: 'str' 3020 """The UUID of the user or group that owns this workflow.""" 3021 created_at: 'str' 3022 """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`.""" 3023 modified_at: 'str' 3024 """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`.""" 3025 modified_by_user_uuid: 'str' 3026 """The UUID of the user that last updated this workflow.""" 3027 name: 'str' 3028 """The name of this workflow assigned by a user.""" 3029 description: 'str' 3030 """A longer HTML description of this workflow assigned by a user. 3031 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 3032 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 3033 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 3034 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 3035 """ 3036 definition: 'str' 3037 """A string with the CWL source of this workflow.""" 3038 3039 3040class WorkflowList(TypedDict, total=False): 3041 """A list of Workflow objects. 3042 3043 This is the dictionary object returned when you call `Workflows.list`. 3044 If you just want to iterate all objects that match your search criteria, 3045 consider using `arvados.util.keyset_list_all`. 3046 If you work with this raw object, the keys of the dictionary are documented 3047 below, along with their types. The `items` key maps to a list of matching 3048 `Workflow` objects. 3049 """ 3050 kind: 'str' = 'arvados#workflowList' 3051 """Object type. Always arvados#workflowList.""" 3052 etag: 'str' 3053 """List cache version.""" 3054 items: 'List[Workflow]' 3055 """An array of matching Workflow objects.""" 3056 3057 3058class Workflows: 3059 """Methods to query and manipulate Arvados workflows""" 3060 3061 def create(self, *, body: "Dict[Literal['workflow'], Workflow]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3062 """Create a new Workflow. 3063 3064 Required parameters: 3065 3066 * body: Dict[Literal['workflow'], Workflow] --- A dictionary with a single item `'workflow'`. 3067 Its value is a `Workflow` dictionary defining the attributes to set. 3068 3069 Optional parameters: 3070 3071 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 3072 3073 * 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`. 3074 3075 * select: Optional[List] --- An array of names of attributes to return in the response. 3076 """ 3077 3078 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Workflow]': 3079 """Delete an existing Workflow. 3080 3081 Required parameters: 3082 3083 * uuid: str --- The UUID of the Workflow to delete. 3084 """ 3085 3086 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3087 """Get a Workflow record by UUID. 3088 3089 Required parameters: 3090 3091 * uuid: str --- The UUID of the Workflow to return. 3092 3093 Optional parameters: 3094 3095 * select: Optional[List] --- An array of names of attributes to return in the response. 3096 """ 3097 3098 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]': 3099 """Retrieve a WorkflowList. 3100 3101 This method returns a single page of `Workflow` objects that match your search 3102 criteria. If you just want to iterate all objects that match your search 3103 criteria, consider using `arvados.util.keyset_list_all`. 3104 3105 Optional parameters: 3106 3107 * bypass_federation: bool --- If true, do not return results from other clusters in the 3108 federation, only the cluster that received the request. 3109 You must be an administrator to use this flag. Default `False`. 3110 3111 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 3112 3113 * count: str --- A string to determine result counting behavior. Supported values are: 3114 3115 * `"exact"`: The response will include an `items_available` field that 3116 counts the number of objects that matched this search criteria, 3117 including ones not included in `items`. 3118 3119 * `"none"`: The response will not include an `items_avaliable` 3120 field. This improves performance by returning a result as soon as enough 3121 `items` have been loaded for this result. 3122 3123 Default `'exact'`. 3124 3125 * distinct: bool --- If this is true, and multiple objects have the same values 3126 for the attributes that you specify in the `select` parameter, then each unique 3127 set of values will only be returned once in the result set. Default `False`. 3128 3129 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 3130 Refer to the [filters reference][] for more information about how to write filters. 3131 3132 [filters reference]: https://doc.arvados.org/api/methods.html#filters 3133 3134 * limit: int --- The maximum number of objects to return in the result. 3135 Note that the API may return fewer results than this if your request hits other 3136 limits set by the administrator. Default `100`. 3137 3138 * offset: int --- Return matching objects starting from this index. 3139 Note that result indexes may change if objects are modified in between a series 3140 of list calls. Default `0`. 3141 3142 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 3143 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 3144 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 3145 3146 * select: Optional[List] --- An array of names of attributes to return from each matching object. 3147 3148 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 3149 The keys of this object are attribute names. 3150 Each value is either a single matching value or an array of matching values for that attribute. 3151 The `filters` parameter is more flexible and preferred. 3152 """ 3153 3154 def update(self, *, body: "Dict[Literal['workflow'], Workflow]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3155 """Update attributes of an existing Workflow. 3156 3157 Required parameters: 3158 3159 * body: Dict[Literal['workflow'], Workflow] --- A dictionary with a single item `'workflow'`. 3160 Its value is a `Workflow` dictionary defining the attributes to set. 3161 3162 * uuid: str --- The UUID of the Workflow to update. 3163 3164 Optional parameters: 3165 3166 * select: Optional[List] --- An array of names of attributes to return in the response. 3167 """ 3168 3169 3170class ArvadosAPIClient(googleapiclient.discovery.Resource): 3171 3172 def api_client_authorizations(self) -> 'ApiClientAuthorizations': 3173 """Return an instance of `ApiClientAuthorizations` to call methods via this client""" 3174 3175 def authorized_keys(self) -> 'AuthorizedKeys': 3176 """Return an instance of `AuthorizedKeys` to call methods via this client""" 3177 3178 def collections(self) -> 'Collections': 3179 """Return an instance of `Collections` to call methods via this client""" 3180 3181 def computed_permissions(self) -> 'ComputedPermissions': 3182 """Return an instance of `ComputedPermissions` to call methods via this client""" 3183 3184 def configs(self) -> 'Configs': 3185 """Return an instance of `Configs` to call methods via this client""" 3186 3187 def container_requests(self) -> 'ContainerRequests': 3188 """Return an instance of `ContainerRequests` to call methods via this client""" 3189 3190 def containers(self) -> 'Containers': 3191 """Return an instance of `Containers` to call methods via this client""" 3192 3193 def groups(self) -> 'Groups': 3194 """Return an instance of `Groups` to call methods via this client""" 3195 3196 def keep_services(self) -> 'KeepServices': 3197 """Return an instance of `KeepServices` to call methods via this client""" 3198 3199 def links(self) -> 'Links': 3200 """Return an instance of `Links` to call methods via this client""" 3201 3202 def logs(self) -> 'Logs': 3203 """Return an instance of `Logs` to call methods via this client""" 3204 3205 def sys(self) -> 'Sys': 3206 """Return an instance of `Sys` to call methods via this client""" 3207 3208 def user_agreements(self) -> 'UserAgreements': 3209 """Return an instance of `UserAgreements` to call methods via this client""" 3210 3211 def users(self) -> 'Users': 3212 """Return an instance of `Users` to call methods via this client""" 3213 3214 def virtual_machines(self) -> 'VirtualMachines': 3215 """Return an instance of `VirtualMachines` to call methods via this client""" 3216 3217 def vocabularies(self) -> 'Vocabularies': 3218 """Return an instance of `Vocabularies` to call methods via this client""" 3219 3220 def workflows(self) -> 'Workflows': 3221 """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, 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 * select: Optional[List] --- An array of names of attributes to return in the response. 550 """ 551 552 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 553 """Delete an existing Collection. 554 555 Required parameters: 556 557 * uuid: str --- The UUID of the Collection to delete. 558 """ 559 560 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 561 """Get a Collection record by UUID. 562 563 Required parameters: 564 565 * uuid: str --- The UUID of the Collection to return. 566 567 Optional parameters: 568 569 * include_trash: bool --- Show collection even if its `is_trashed` attribute is true. Default `False`. 570 571 * select: Optional[List] --- An array of names of attributes to return in the response. 572 """ 573 574 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]': 575 """Retrieve a CollectionList. 576 577 This method returns a single page of `Collection` objects that match your search 578 criteria. If you just want to iterate all objects that match your search 579 criteria, consider using `arvados.util.keyset_list_all`. 580 581 Optional parameters: 582 583 * bypass_federation: bool --- If true, do not return results from other clusters in the 584 federation, only the cluster that received the request. 585 You must be an administrator to use this flag. Default `False`. 586 587 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 588 589 * count: str --- A string to determine result counting behavior. Supported values are: 590 591 * `"exact"`: The response will include an `items_available` field that 592 counts the number of objects that matched this search criteria, 593 including ones not included in `items`. 594 595 * `"none"`: The response will not include an `items_avaliable` 596 field. This improves performance by returning a result as soon as enough 597 `items` have been loaded for this result. 598 599 Default `'exact'`. 600 601 * distinct: bool --- If this is true, and multiple objects have the same values 602 for the attributes that you specify in the `select` parameter, then each unique 603 set of values will only be returned once in the result set. Default `False`. 604 605 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 606 Refer to the [filters reference][] for more information about how to write filters. 607 608 [filters reference]: https://doc.arvados.org/api/methods.html#filters 609 610 * include_old_versions: bool --- Include past collection versions. Default `False`. 611 612 * include_trash: bool --- Include collections whose `is_trashed` attribute is true. Default `False`. 613 614 * limit: int --- The maximum number of objects to return in the result. 615 Note that the API may return fewer results than this if your request hits other 616 limits set by the administrator. Default `100`. 617 618 * offset: int --- Return matching objects starting from this index. 619 Note that result indexes may change if objects are modified in between a series 620 of list calls. Default `0`. 621 622 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 623 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 624 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 625 626 * select: Optional[List] --- An array of names of attributes to return from each matching object. 627 628 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 629 The keys of this object are attribute names. 630 Each value is either a single matching value or an array of matching values for that attribute. 631 The `filters` parameter is more flexible and preferred. 632 """ 633 634 def provenance(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 635 """Detail the provenance of a given collection. 636 637 Required parameters: 638 639 * uuid: str --- The UUID of the Collection to query. 640 """ 641 642 def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 643 """Trash a collection. 644 645 Required parameters: 646 647 * uuid: str --- The UUID of the Collection to update. 648 """ 649 650 def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 651 """Untrash a collection. 652 653 Required parameters: 654 655 * uuid: str --- The UUID of the Collection to update. 656 """ 657 658 def update(self, *, body: "Dict[Literal['collection'], Collection]", uuid: 'str', replace_files: 'Optional[Dict[str, Any]]' = None, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 659 """Update attributes of an existing Collection. 660 661 Required parameters: 662 663 * body: Dict[Literal['collection'], Collection] --- A dictionary with a single item `'collection'`. 664 Its value is a `Collection` dictionary defining the attributes to set. 665 666 * uuid: str --- The UUID of the Collection to update. 667 668 Optional parameters: 669 670 * replace_files: Optional[Dict[str, Any]] --- Add, delete, and replace files and directories with new content 671 and/or content from other collections. Refer to the 672 [replace_files reference][] for details. 673 674 [replace_files reference]: https://doc.arvados.org/api/methods/collections.html#replace_files 675 676 * select: Optional[List] --- An array of names of attributes to return in the response. 677 """ 678 679 def used_by(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 680 """Detail where a given collection has been used. 681 682 Required parameters: 683 684 * uuid: str --- The UUID of the Collection to query. 685 """
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, 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, 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 * select: Optional[List] --- An array of names of attributes to return in the response. 550 """
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.
select: Optional[List] — An array of names of attributes to return in the response.
552 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 553 """Delete an existing Collection. 554 555 Required parameters: 556 557 * uuid: str --- The UUID of the Collection to delete. 558 """
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]:
560 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 561 """Get a Collection record by UUID. 562 563 Required parameters: 564 565 * uuid: str --- The UUID of the Collection to return. 566 567 Optional parameters: 568 569 * include_trash: bool --- Show collection even if its `is_trashed` attribute is true. Default `False`. 570 571 * select: Optional[List] --- An array of names of attributes to return in the response. 572 """
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]:
574 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]': 575 """Retrieve a CollectionList. 576 577 This method returns a single page of `Collection` objects that match your search 578 criteria. If you just want to iterate all objects that match your search 579 criteria, consider using `arvados.util.keyset_list_all`. 580 581 Optional parameters: 582 583 * bypass_federation: bool --- If true, do not return results from other clusters in the 584 federation, only the cluster that received the request. 585 You must be an administrator to use this flag. Default `False`. 586 587 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 588 589 * count: str --- A string to determine result counting behavior. Supported values are: 590 591 * `"exact"`: The response will include an `items_available` field that 592 counts the number of objects that matched this search criteria, 593 including ones not included in `items`. 594 595 * `"none"`: The response will not include an `items_avaliable` 596 field. This improves performance by returning a result as soon as enough 597 `items` have been loaded for this result. 598 599 Default `'exact'`. 600 601 * distinct: bool --- If this is true, and multiple objects have the same values 602 for the attributes that you specify in the `select` parameter, then each unique 603 set of values will only be returned once in the result set. Default `False`. 604 605 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 606 Refer to the [filters reference][] for more information about how to write filters. 607 608 [filters reference]: https://doc.arvados.org/api/methods.html#filters 609 610 * include_old_versions: bool --- Include past collection versions. Default `False`. 611 612 * include_trash: bool --- Include collections whose `is_trashed` attribute is true. Default `False`. 613 614 * limit: int --- The maximum number of objects to return in the result. 615 Note that the API may return fewer results than this if your request hits other 616 limits set by the administrator. Default `100`. 617 618 * offset: int --- Return matching objects starting from this index. 619 Note that result indexes may change if objects are modified in between a series 620 of list calls. Default `0`. 621 622 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 623 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 624 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 625 626 * select: Optional[List] --- An array of names of attributes to return from each matching object. 627 628 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 629 The keys of this object are attribute names. 630 Each value is either a single matching value or an array of matching values for that attribute. 631 The `filters` parameter is more flexible and preferred. 632 """
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.
634 def provenance(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 635 """Detail the provenance of a given collection. 636 637 Required parameters: 638 639 * uuid: str --- The UUID of the Collection to query. 640 """
Detail the provenance of a given collection.
Required parameters:
- uuid: str — The UUID of the Collection to query.
642 def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 643 """Trash a collection. 644 645 Required parameters: 646 647 * uuid: str --- The UUID of the Collection to update. 648 """
Trash a collection.
Required parameters:
- uuid: str — The UUID of the Collection to update.
650 def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 651 """Untrash a collection. 652 653 Required parameters: 654 655 * uuid: str --- The UUID of the Collection to update. 656 """
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, select: Optional[List] = None) -> ArvadosAPIRequest[Collection]:
658 def update(self, *, body: "Dict[Literal['collection'], Collection]", uuid: 'str', replace_files: 'Optional[Dict[str, Any]]' = None, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Collection]': 659 """Update attributes of an existing Collection. 660 661 Required parameters: 662 663 * body: Dict[Literal['collection'], Collection] --- A dictionary with a single item `'collection'`. 664 Its value is a `Collection` dictionary defining the attributes to set. 665 666 * uuid: str --- The UUID of the Collection to update. 667 668 Optional parameters: 669 670 * replace_files: Optional[Dict[str, Any]] --- Add, delete, and replace files and directories with new content 671 and/or content from other collections. Refer to the 672 [replace_files reference][] for details. 673 674 [replace_files reference]: https://doc.arvados.org/api/methods/collections.html#replace_files 675 676 * select: Optional[List] --- An array of names of attributes to return in the response. 677 """
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.
select: Optional[List] — An array of names of attributes to return in the response.
679 def used_by(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]': 680 """Detail where a given collection has been used. 681 682 Required parameters: 683 684 * uuid: str --- The UUID of the Collection to query. 685 """
Detail where a given collection has been used.
Required parameters:
- uuid: str — The UUID of the Collection to query.
class
ComputedPermission(typing.TypedDict):
688class ComputedPermission(TypedDict, total=False): 689 """Arvados computed permission 690 691 Computed permissions do not correspond directly to any Arvados resource, but 692 provide a simple way to query the entire graph of permissions granted to 693 users and groups. 694 695 This is the dictionary object that represents a single ComputedPermission in Arvados 696 and is returned by most `ComputedPermissions` methods. 697 The keys of the dictionary are documented below, along with their types. 698 Not every key may appear in every dictionary returned by an API call. 699 When a method doesn't return all the data, you can use its `select` parameter 700 to list the specific keys you need. Refer to the API documentation for details. 701 """ 702 user_uuid: 'str' 703 """The UUID of the Arvados user who has this permission.""" 704 target_uuid: 'str' 705 """The UUID of the Arvados object the user has access to.""" 706 perm_level: 'str' 707 """A string representing the user's level of access to the target object. 708 Possible values are: 709 710 * `"can_read"` 711 * `"can_write"` 712 * `"can_manage"` 713 """
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):
716class ComputedPermissionList(TypedDict, total=False): 717 """A list of ComputedPermission objects. 718 719 This is the dictionary object returned when you call `ComputedPermissions.list`. 720 If you just want to iterate all objects that match your search criteria, 721 consider using `arvados.util.iter_computed_permissions`. 722 If you work with this raw object, the keys of the dictionary are documented 723 below, along with their types. The `items` key maps to a list of matching 724 `ComputedPermission` objects. 725 """ 726 kind: 'str' = 'arvados#computedPermissionList' 727 """Object type. Always arvados#computedPermissionList.""" 728 etag: 'str' 729 """List cache version.""" 730 items: 'List[ComputedPermission]' 731 """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:
734class ComputedPermissions: 735 """Methods to query and manipulate Arvados computed permissions""" 736 737 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]': 738 """Retrieve a ComputedPermissionList. 739 740 This method returns a single page of `ComputedPermission` objects that match your search 741 criteria. If you just want to iterate all objects that match your search 742 criteria, consider using `arvados.util.iter_computed_permissions`. 743 744 Optional parameters: 745 746 * count: str --- A string to determine result counting behavior. Supported values are: 747 748 * `"exact"`: The response will include an `items_available` field that 749 counts the number of objects that matched this search criteria, 750 including ones not included in `items`. 751 752 * `"none"`: The response will not include an `items_avaliable` 753 field. This improves performance by returning a result as soon as enough 754 `items` have been loaded for this result. 755 756 Default `'exact'`. 757 758 * distinct: bool --- If this is true, and multiple objects have the same values 759 for the attributes that you specify in the `select` parameter, then each unique 760 set of values will only be returned once in the result set. Default `False`. 761 762 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 763 Refer to the [filters reference][] for more information about how to write filters. 764 765 [filters reference]: https://doc.arvados.org/api/methods.html#filters 766 767 * limit: int --- The maximum number of objects to return in the result. 768 Note that the API may return fewer results than this if your request hits other 769 limits set by the administrator. Default `100`. 770 771 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 772 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 773 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 774 775 * select: Optional[List] --- An array of names of attributes to return from each matching object. 776 777 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 778 The keys of this object are attribute names. 779 Each value is either a single matching value or an array of matching values for that attribute. 780 The `filters` parameter is more flexible and preferred. 781 """
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]:
737 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]': 738 """Retrieve a ComputedPermissionList. 739 740 This method returns a single page of `ComputedPermission` objects that match your search 741 criteria. If you just want to iterate all objects that match your search 742 criteria, consider using `arvados.util.iter_computed_permissions`. 743 744 Optional parameters: 745 746 * count: str --- A string to determine result counting behavior. Supported values are: 747 748 * `"exact"`: The response will include an `items_available` field that 749 counts the number of objects that matched this search criteria, 750 including ones not included in `items`. 751 752 * `"none"`: The response will not include an `items_avaliable` 753 field. This improves performance by returning a result as soon as enough 754 `items` have been loaded for this result. 755 756 Default `'exact'`. 757 758 * distinct: bool --- If this is true, and multiple objects have the same values 759 for the attributes that you specify in the `select` parameter, then each unique 760 set of values will only be returned once in the result set. Default `False`. 761 762 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 763 Refer to the [filters reference][] for more information about how to write filters. 764 765 [filters reference]: https://doc.arvados.org/api/methods.html#filters 766 767 * limit: int --- The maximum number of objects to return in the result. 768 Note that the API may return fewer results than this if your request hits other 769 limits set by the administrator. Default `100`. 770 771 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 772 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 773 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 774 775 * select: Optional[List] --- An array of names of attributes to return from each matching object. 776 777 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 778 The keys of this object are attribute names. 779 Each value is either a single matching value or an array of matching values for that attribute. 780 The `filters` parameter is more flexible and preferred. 781 """
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:
784class Configs: 785 """Methods to query and manipulate Arvados configs""" 786 787 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 788 """Get this cluster's public configuration settings."""
Methods to query and manipulate Arvados configs
class
ContainerRequest(typing.TypedDict):
791class ContainerRequest(TypedDict, total=False): 792 """Arvados container request 793 794 A container request represents a user's request that Arvados do some compute 795 work, along with full details about what work should be done. Arvados will 796 attempt to fulfill the request by mapping it to a matching container record, 797 running the work on demand if necessary. 798 799 This is the dictionary object that represents a single ContainerRequest in Arvados 800 and is returned by most `ContainerRequests` methods. 801 The keys of the dictionary are documented below, along with their types. 802 Not every key may appear in every dictionary returned by an API call. 803 When a method doesn't return all the data, you can use its `select` parameter 804 to list the specific keys you need. Refer to the API documentation for details. 805 """ 806 etag: 'str' 807 """Object cache version.""" 808 uuid: 'str' 809 """This container request's Arvados UUID, like `zzzzz-xvhdp-12345abcde67890`.""" 810 owner_uuid: 'str' 811 """The UUID of the user or group that owns this container request.""" 812 created_at: 'str' 813 """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`.""" 814 modified_at: 'str' 815 """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`.""" 816 modified_by_user_uuid: 'str' 817 """The UUID of the user that last updated this container request.""" 818 name: 'str' 819 """The name of this container request assigned by a user.""" 820 description: 'str' 821 """A longer HTML description of this container request assigned by a user. 822 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 823 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 824 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 825 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 826 """ 827 properties: 'Dict[str, Any]' 828 """A hash of arbitrary metadata for this container request. 829 Some keys may be reserved by Arvados or defined by a configured vocabulary. 830 Refer to the [metadata properties reference][] for details. 831 832 [metadata properties reference]: https://doc.arvados.org/api/properties.html 833 """ 834 state: 'str' 835 """A string indicating where this container request is in its lifecycle. 836 Possible values are: 837 838 * `"Uncommitted"` --- The container request has not been finalized and can still be edited. 839 * `"Committed"` --- The container request is ready to be fulfilled. 840 * `"Final"` --- The container request has been fulfilled or cancelled. 841 """ 842 requesting_container_uuid: 'str' 843 """The UUID of the container that created this container request, if any.""" 844 container_uuid: 'str' 845 """The UUID of the container that fulfills this container request, if any.""" 846 container_count_max: 'int' 847 """An integer that defines the maximum number of times Arvados should attempt 848 to dispatch a container to fulfill this container request. 849 """ 850 mounts: 'Dict[str, Any]' 851 """A hash where each key names a directory inside this container, and its 852 value is an object that defines the mount source for that directory. Refer 853 to the [mount types reference][] for details. 854 855 [mount types reference]: https://doc.arvados.org/api/methods/containers.html#mount_types 856 """ 857 runtime_constraints: 'Dict[str, Any]' 858 """A hash that identifies compute resources this container requires to run 859 successfully. See the [runtime constraints reference][] for details. 860 861 [runtime constraints reference]: https://doc.arvados.org/api/methods/containers.html#runtime_constraints 862 """ 863 container_image: 'str' 864 """The portable data hash of the Arvados collection that contains the image 865 to use for this container. 866 """ 867 environment: 'Dict[str, Any]' 868 """A hash of string keys and values that defines the environment variables 869 for the dispatcher to set when it executes this container. 870 """ 871 cwd: 'str' 872 """A string that the defines the working directory that the dispatcher should 873 use when it executes the command inside this container. 874 """ 875 command: 'List' 876 """An array of strings that defines the command that the dispatcher should 877 execute inside this container. 878 """ 879 output_path: 'str' 880 """A string that defines the file or directory path where the command 881 writes output that should be saved from this container. 882 """ 883 priority: 'int' 884 """An integer between 0 and 1000 (inclusive) that represents this container request's 885 scheduling priority. 0 represents a request to be cancelled. Higher 886 values represent higher priority. Refer to the [priority reference][] for details. 887 888 [priority reference]: https://doc.arvados.org/api/methods/container_requests.html#priority 889 """ 890 expires_at: 'str' 891 """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`.""" 892 filters: 'str' 893 """Filters that limit which existing containers are eligible to satisfy this 894 container request. This attribute is not implemented yet and should be null. 895 """ 896 container_count: 'int' 897 """An integer that records how many times Arvados has attempted to dispatch 898 a container to fulfill this container request. 899 """ 900 use_existing: 'bool' 901 """A boolean flag. If set, Arvados may choose to satisfy this container 902 request with an eligible container that already exists. Otherwise, Arvados will 903 satisfy this container request with a newer container, which will usually result 904 in the container running again. 905 """ 906 scheduling_parameters: 'Dict[str, Any]' 907 """A hash of scheduling parameters that should be passed to the underlying 908 dispatcher when this container is run. 909 See the [scheduling parameters reference][] for details. 910 911 [scheduling parameters reference]: https://doc.arvados.org/api/methods/containers.html#scheduling_parameters 912 """ 913 output_uuid: 'str' 914 """The UUID of the Arvados collection that contains output for all the 915 container(s) that were dispatched to fulfill this container request. 916 """ 917 log_uuid: 'str' 918 """The UUID of the Arvados collection that contains logs for all the 919 container(s) that were dispatched to fulfill this container request. 920 """ 921 output_name: 'str' 922 """The name to set on the output collection of this container request.""" 923 output_ttl: 'int' 924 """An integer in seconds. If greater than zero, when an output collection is 925 created for this container request, its `expires_at` attribute will be set this 926 far in the future. 927 """ 928 output_storage_classes: 'List' 929 """An array of strings identifying the storage class(es) that should be set 930 on the output collection of this container request. Storage classes are configured by 931 the cluster administrator. 932 """ 933 output_properties: 'Dict[str, Any]' 934 """A hash of arbitrary metadata to set on the output collection of this container request. 935 Some keys may be reserved by Arvados or defined by a configured vocabulary. 936 Refer to the [metadata properties reference][] for details. 937 938 [metadata properties reference]: https://doc.arvados.org/api/properties.html 939 """ 940 cumulative_cost: 'float' 941 """A float with the estimated cost of all cloud instances used to run 942 container(s) to fulfill this container request and their subrequests. 943 The value is `0` if cost estimation is not available on this cluster. 944 """ 945 output_glob: 'List' 946 """An array of strings of shell-style glob patterns that define which file(s) 947 and subdirectory(ies) under the `output_path` directory should be recorded in 948 the container's final output. Refer to the [glob patterns reference][] for details. 949 950 [glob patterns reference]: https://doc.arvados.org/api/methods/containers.html#glob_patterns 951 """
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.
class
ContainerRequestList(typing.TypedDict):
954class ContainerRequestList(TypedDict, total=False): 955 """A list of ContainerRequest objects. 956 957 This is the dictionary object returned when you call `ContainerRequests.list`. 958 If you just want to iterate all objects that match your search criteria, 959 consider using `arvados.util.keyset_list_all`. 960 If you work with this raw object, the keys of the dictionary are documented 961 below, along with their types. The `items` key maps to a list of matching 962 `ContainerRequest` objects. 963 """ 964 kind: 'str' = 'arvados#containerRequestList' 965 """Object type. Always arvados#containerRequestList.""" 966 etag: 'str' 967 """List cache version.""" 968 items: 'List[ContainerRequest]' 969 """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:
972class ContainerRequests: 973 """Methods to query and manipulate Arvados container requests""" 974 975 def container_status(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]': 976 """Return scheduling details for a container request. 977 978 Required parameters: 979 980 * uuid: str --- The UUID of the container request to query. 981 """ 982 983 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]': 984 """Create a new ContainerRequest. 985 986 Required parameters: 987 988 * body: Dict[Literal['container_request'], ContainerRequest] --- A dictionary with a single item `'container_request'`. 989 Its value is a `ContainerRequest` dictionary defining the attributes to set. 990 991 Optional parameters: 992 993 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 994 995 * 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`. 996 997 * select: Optional[List] --- An array of names of attributes to return in the response. 998 """ 999 1000 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]': 1001 """Delete an existing ContainerRequest. 1002 1003 Required parameters: 1004 1005 * uuid: str --- The UUID of the ContainerRequest to delete. 1006 """ 1007 1008 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1009 """Get a ContainerRequest record by UUID. 1010 1011 Required parameters: 1012 1013 * uuid: str --- The UUID of the ContainerRequest to return. 1014 1015 Optional parameters: 1016 1017 * include_trash: bool --- Show container request even if its owner project is trashed. Default `False`. 1018 1019 * select: Optional[List] --- An array of names of attributes to return in the response. 1020 """ 1021 1022 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]': 1023 """Retrieve a ContainerRequestList. 1024 1025 This method returns a single page of `ContainerRequest` objects that match your search 1026 criteria. If you just want to iterate all objects that match your search 1027 criteria, consider using `arvados.util.keyset_list_all`. 1028 1029 Optional parameters: 1030 1031 * bypass_federation: bool --- If true, do not return results from other clusters in the 1032 federation, only the cluster that received the request. 1033 You must be an administrator to use this flag. Default `False`. 1034 1035 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1036 1037 * count: str --- A string to determine result counting behavior. Supported values are: 1038 1039 * `"exact"`: The response will include an `items_available` field that 1040 counts the number of objects that matched this search criteria, 1041 including ones not included in `items`. 1042 1043 * `"none"`: The response will not include an `items_avaliable` 1044 field. This improves performance by returning a result as soon as enough 1045 `items` have been loaded for this result. 1046 1047 Default `'exact'`. 1048 1049 * distinct: bool --- If this is true, and multiple objects have the same values 1050 for the attributes that you specify in the `select` parameter, then each unique 1051 set of values will only be returned once in the result set. Default `False`. 1052 1053 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1054 Refer to the [filters reference][] for more information about how to write filters. 1055 1056 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1057 1058 * include_trash: bool --- Include container requests whose owner project is trashed. Default `False`. 1059 1060 * limit: int --- The maximum number of objects to return in the result. 1061 Note that the API may return fewer results than this if your request hits other 1062 limits set by the administrator. Default `100`. 1063 1064 * offset: int --- Return matching objects starting from this index. 1065 Note that result indexes may change if objects are modified in between a series 1066 of list calls. Default `0`. 1067 1068 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1069 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1070 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1071 1072 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1073 1074 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1075 The keys of this object are attribute names. 1076 Each value is either a single matching value or an array of matching values for that attribute. 1077 The `filters` parameter is more flexible and preferred. 1078 """ 1079 1080 def update(self, *, body: "Dict[Literal['container_request'], ContainerRequest]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1081 """Update attributes of an existing ContainerRequest. 1082 1083 Required parameters: 1084 1085 * body: Dict[Literal['container_request'], ContainerRequest] --- A dictionary with a single item `'container_request'`. 1086 Its value is a `ContainerRequest` dictionary defining the attributes to set. 1087 1088 * uuid: str --- The UUID of the ContainerRequest to update. 1089 1090 Optional parameters: 1091 1092 * select: Optional[List] --- An array of names of attributes to return in the response. 1093 """
Methods to query and manipulate Arvados container requests
975 def container_status(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]': 976 """Return scheduling details for a container request. 977 978 Required parameters: 979 980 * uuid: str --- The UUID of the container request to query. 981 """
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]:
983 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]': 984 """Create a new ContainerRequest. 985 986 Required parameters: 987 988 * body: Dict[Literal['container_request'], ContainerRequest] --- A dictionary with a single item `'container_request'`. 989 Its value is a `ContainerRequest` dictionary defining the attributes to set. 990 991 Optional parameters: 992 993 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 994 995 * 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`. 996 997 * select: Optional[List] --- An array of names of attributes to return in the response. 998 """
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.
1000 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]': 1001 """Delete an existing ContainerRequest. 1002 1003 Required parameters: 1004 1005 * uuid: str --- The UUID of the ContainerRequest to delete. 1006 """
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]:
1008 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1009 """Get a ContainerRequest record by UUID. 1010 1011 Required parameters: 1012 1013 * uuid: str --- The UUID of the ContainerRequest to return. 1014 1015 Optional parameters: 1016 1017 * include_trash: bool --- Show container request even if its owner project is trashed. Default `False`. 1018 1019 * select: Optional[List] --- An array of names of attributes to return in the response. 1020 """
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]:
1022 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]': 1023 """Retrieve a ContainerRequestList. 1024 1025 This method returns a single page of `ContainerRequest` objects that match your search 1026 criteria. If you just want to iterate all objects that match your search 1027 criteria, consider using `arvados.util.keyset_list_all`. 1028 1029 Optional parameters: 1030 1031 * bypass_federation: bool --- If true, do not return results from other clusters in the 1032 federation, only the cluster that received the request. 1033 You must be an administrator to use this flag. Default `False`. 1034 1035 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1036 1037 * count: str --- A string to determine result counting behavior. Supported values are: 1038 1039 * `"exact"`: The response will include an `items_available` field that 1040 counts the number of objects that matched this search criteria, 1041 including ones not included in `items`. 1042 1043 * `"none"`: The response will not include an `items_avaliable` 1044 field. This improves performance by returning a result as soon as enough 1045 `items` have been loaded for this result. 1046 1047 Default `'exact'`. 1048 1049 * distinct: bool --- If this is true, and multiple objects have the same values 1050 for the attributes that you specify in the `select` parameter, then each unique 1051 set of values will only be returned once in the result set. Default `False`. 1052 1053 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1054 Refer to the [filters reference][] for more information about how to write filters. 1055 1056 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1057 1058 * include_trash: bool --- Include container requests whose owner project is trashed. Default `False`. 1059 1060 * limit: int --- The maximum number of objects to return in the result. 1061 Note that the API may return fewer results than this if your request hits other 1062 limits set by the administrator. Default `100`. 1063 1064 * offset: int --- Return matching objects starting from this index. 1065 Note that result indexes may change if objects are modified in between a series 1066 of list calls. Default `0`. 1067 1068 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1069 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1070 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1071 1072 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1073 1074 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1075 The keys of this object are attribute names. 1076 Each value is either a single matching value or an array of matching values for that attribute. 1077 The `filters` parameter is more flexible and preferred. 1078 """
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]:
1080 def update(self, *, body: "Dict[Literal['container_request'], ContainerRequest]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[ContainerRequest]': 1081 """Update attributes of an existing ContainerRequest. 1082 1083 Required parameters: 1084 1085 * body: Dict[Literal['container_request'], ContainerRequest] --- A dictionary with a single item `'container_request'`. 1086 Its value is a `ContainerRequest` dictionary defining the attributes to set. 1087 1088 * uuid: str --- The UUID of the ContainerRequest to update. 1089 1090 Optional parameters: 1091 1092 * select: Optional[List] --- An array of names of attributes to return in the response. 1093 """
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):
1096class Container(TypedDict, total=False): 1097 """Arvados container record 1098 1099 A container represents compute work that has been or should be dispatched, 1100 along with its results. A container can satisfy one or more container requests. 1101 1102 This is the dictionary object that represents a single Container in Arvados 1103 and is returned by most `Containers` methods. 1104 The keys of the dictionary are documented below, along with their types. 1105 Not every key may appear in every dictionary returned by an API call. 1106 When a method doesn't return all the data, you can use its `select` parameter 1107 to list the specific keys you need. Refer to the API documentation for details. 1108 """ 1109 etag: 'str' 1110 """Object cache version.""" 1111 uuid: 'str' 1112 """This container's Arvados UUID, like `zzzzz-dz642-12345abcde67890`.""" 1113 owner_uuid: 'str' 1114 """The UUID of the user or group that owns this container.""" 1115 created_at: 'str' 1116 """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`.""" 1117 modified_at: 'str' 1118 """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`.""" 1119 modified_by_user_uuid: 'str' 1120 """The UUID of the user that last updated this container.""" 1121 state: 'str' 1122 """A string representing the container's current execution status. Possible 1123 values are: 1124 1125 * `"Queued"` --- This container has not been dispatched yet. 1126 * `"Locked"` --- A dispatcher has claimed this container in preparation to run it. 1127 * `"Running"` --- A dispatcher is running this container. 1128 * `"Cancelled"` --- Container execution has been cancelled by user request. 1129 * `"Complete"` --- A dispatcher ran this container to completion and recorded the results. 1130 """ 1131 started_at: 'str' 1132 """The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1133 finished_at: 'str' 1134 """The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 1135 log: 'str' 1136 """The portable data hash of the Arvados collection that contains this 1137 container's logs. 1138 """ 1139 environment: 'Dict[str, Any]' 1140 """A hash of string keys and values that defines the environment variables 1141 for the dispatcher to set when it executes this container. 1142 """ 1143 cwd: 'str' 1144 """A string that the defines the working directory that the dispatcher should 1145 use when it executes the command inside this container. 1146 """ 1147 command: 'List' 1148 """An array of strings that defines the command that the dispatcher should 1149 execute inside this container. 1150 """ 1151 output_path: 'str' 1152 """A string that defines the file or directory path where the command 1153 writes output that should be saved from this container. 1154 """ 1155 mounts: 'Dict[str, Any]' 1156 """A hash where each key names a directory inside this container, and its 1157 value is an object that defines the mount source for that directory. Refer 1158 to the [mount types reference][] for details. 1159 1160 [mount types reference]: https://doc.arvados.org/api/methods/containers.html#mount_types 1161 """ 1162 runtime_constraints: 'Dict[str, Any]' 1163 """A hash that identifies compute resources this container requires to run 1164 successfully. See the [runtime constraints reference][] for details. 1165 1166 [runtime constraints reference]: https://doc.arvados.org/api/methods/containers.html#runtime_constraints 1167 """ 1168 output: 'str' 1169 """The portable data hash of the Arvados collection that contains this 1170 container's output file(s). 1171 """ 1172 container_image: 'str' 1173 """The portable data hash of the Arvados collection that contains the image 1174 to use for this container. 1175 """ 1176 progress: 'float' 1177 """A float between 0.0 and 1.0 (inclusive) that represents the container's 1178 execution progress. This attribute is not implemented yet. 1179 """ 1180 priority: 'int' 1181 """An integer between 0 and 1000 (inclusive) that represents this container's 1182 scheduling priority. 0 represents a request to be cancelled. Higher 1183 values represent higher priority. Refer to the [priority reference][] for details. 1184 1185 [priority reference]: https://doc.arvados.org/api/methods/container_requests.html#priority 1186 """ 1187 exit_code: 'int' 1188 """An integer that records the Unix exit code of the `command` from a 1189 finished container. 1190 """ 1191 auth_uuid: 'str' 1192 """The UUID of the Arvados API client authorization token that a dispatcher 1193 should use to set up this container. This token is automatically created by 1194 Arvados and this attribute automatically assigned unless a container is 1195 created with `runtime_token`. 1196 """ 1197 locked_by_uuid: 'str' 1198 """The UUID of the Arvados API client authorization token that successfully 1199 locked this container in preparation to execute it. 1200 """ 1201 scheduling_parameters: 'Dict[str, Any]' 1202 """A hash of scheduling parameters that should be passed to the underlying 1203 dispatcher when this container is run. 1204 See the [scheduling parameters reference][] for details. 1205 1206 [scheduling parameters reference]: https://doc.arvados.org/api/methods/containers.html#scheduling_parameters 1207 """ 1208 runtime_status: 'Dict[str, Any]' 1209 """A hash with status updates from a running container. 1210 Refer to the [runtime status reference][] for details. 1211 1212 [runtime status reference]: https://doc.arvados.org/api/methods/containers.html#runtime_status 1213 """ 1214 runtime_user_uuid: 'str' 1215 """The UUID of the Arvados user associated with the API client authorization 1216 token used to run this container. 1217 """ 1218 runtime_auth_scopes: 'List' 1219 """The `scopes` from the API client authorization token used to run this container.""" 1220 lock_count: 'int' 1221 """The number of times this container has been locked by a dispatcher. This 1222 may be greater than 1 if a dispatcher locks a container but then execution is 1223 interrupted for any reason. 1224 """ 1225 gateway_address: 'str' 1226 """A string with the address of the Arvados gateway server, in `HOST:PORT` 1227 format. This is for internal use only. 1228 """ 1229 interactive_session_started: 'bool' 1230 """This flag is set true if any user starts an interactive shell inside the 1231 running container. 1232 """ 1233 output_storage_classes: 'List' 1234 """An array of strings identifying the storage class(es) that should be set 1235 on the output collection of this container. Storage classes are configured by 1236 the cluster administrator. 1237 """ 1238 output_properties: 'Dict[str, Any]' 1239 """A hash of arbitrary metadata to set on the output collection of this container. 1240 Some keys may be reserved by Arvados or defined by a configured vocabulary. 1241 Refer to the [metadata properties reference][] for details. 1242 1243 [metadata properties reference]: https://doc.arvados.org/api/properties.html 1244 """ 1245 cost: 'float' 1246 """A float with the estimated cost of the cloud instance used to run this 1247 container. The value is `0` if cost estimation is not available on this cluster. 1248 """ 1249 subrequests_cost: 'float' 1250 """A float with the estimated cost of all cloud instances used to run this 1251 container and all its subrequests. The value is `0` if cost estimation is not 1252 available on this cluster. 1253 """ 1254 output_glob: 'List' 1255 """An array of strings of shell-style glob patterns that define which file(s) 1256 and subdirectory(ies) under the `output_path` directory should be recorded in 1257 the container's final output. Refer to the [glob patterns reference][] for details. 1258 1259 [glob patterns reference]: https://doc.arvados.org/api/methods/containers.html#glob_patterns 1260 """
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.
class
ContainerList(typing.TypedDict):
1263class ContainerList(TypedDict, total=False): 1264 """A list of Container objects. 1265 1266 This is the dictionary object returned when you call `Containers.list`. 1267 If you just want to iterate all objects that match your search criteria, 1268 consider using `arvados.util.keyset_list_all`. 1269 If you work with this raw object, the keys of the dictionary are documented 1270 below, along with their types. The `items` key maps to a list of matching 1271 `Container` objects. 1272 """ 1273 kind: 'str' = 'arvados#containerList' 1274 """Object type. Always arvados#containerList.""" 1275 etag: 'str' 1276 """List cache version.""" 1277 items: 'List[Container]' 1278 """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:
1281class Containers: 1282 """Methods to query and manipulate Arvados containers""" 1283 1284 def auth(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1285 """Get the API client authorization token associated with this container. 1286 1287 Required parameters: 1288 1289 * uuid: str --- The UUID of the Container to query. 1290 """ 1291 1292 def create(self, *, body: "Dict[Literal['container'], Container]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1293 """Create a new Container. 1294 1295 Required parameters: 1296 1297 * body: Dict[Literal['container'], Container] --- A dictionary with a single item `'container'`. 1298 Its value is a `Container` dictionary defining the attributes to set. 1299 1300 Optional parameters: 1301 1302 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1303 1304 * 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`. 1305 1306 * select: Optional[List] --- An array of names of attributes to return in the response. 1307 """ 1308 1309 def current(self) -> 'ArvadosAPIRequest[Container]': 1310 """Return the container record associated with the API token authorizing this request.""" 1311 1312 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1313 """Delete an existing Container. 1314 1315 Required parameters: 1316 1317 * uuid: str --- The UUID of the Container to delete. 1318 """ 1319 1320 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1321 """Get a Container record by UUID. 1322 1323 Required parameters: 1324 1325 * uuid: str --- The UUID of the Container to return. 1326 1327 Optional parameters: 1328 1329 * select: Optional[List] --- An array of names of attributes to return in the response. 1330 """ 1331 1332 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]': 1333 """Retrieve a ContainerList. 1334 1335 This method returns a single page of `Container` objects that match your search 1336 criteria. If you just want to iterate all objects that match your search 1337 criteria, consider using `arvados.util.keyset_list_all`. 1338 1339 Optional parameters: 1340 1341 * bypass_federation: bool --- If true, do not return results from other clusters in the 1342 federation, only the cluster that received the request. 1343 You must be an administrator to use this flag. Default `False`. 1344 1345 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1346 1347 * count: str --- A string to determine result counting behavior. Supported values are: 1348 1349 * `"exact"`: The response will include an `items_available` field that 1350 counts the number of objects that matched this search criteria, 1351 including ones not included in `items`. 1352 1353 * `"none"`: The response will not include an `items_avaliable` 1354 field. This improves performance by returning a result as soon as enough 1355 `items` have been loaded for this result. 1356 1357 Default `'exact'`. 1358 1359 * distinct: bool --- If this is true, and multiple objects have the same values 1360 for the attributes that you specify in the `select` parameter, then each unique 1361 set of values will only be returned once in the result set. Default `False`. 1362 1363 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1364 Refer to the [filters reference][] for more information about how to write filters. 1365 1366 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1367 1368 * limit: int --- The maximum number of objects to return in the result. 1369 Note that the API may return fewer results than this if your request hits other 1370 limits set by the administrator. Default `100`. 1371 1372 * offset: int --- Return matching objects starting from this index. 1373 Note that result indexes may change if objects are modified in between a series 1374 of list calls. Default `0`. 1375 1376 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1377 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1378 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1379 1380 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1381 1382 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1383 The keys of this object are attribute names. 1384 Each value is either a single matching value or an array of matching values for that attribute. 1385 The `filters` parameter is more flexible and preferred. 1386 """ 1387 1388 def lock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1389 """Lock a container (for a dispatcher to begin running it). 1390 1391 Required parameters: 1392 1393 * uuid: str --- The UUID of the Container to update. 1394 """ 1395 1396 def secret_mounts(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1397 """Return secret mount information for the container associated with the API token authorizing this request. 1398 1399 Required parameters: 1400 1401 * uuid: str --- The UUID of the Container to query. 1402 """ 1403 1404 def unlock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1405 """Unlock a container (for a dispatcher to stop running it). 1406 1407 Required parameters: 1408 1409 * uuid: str --- The UUID of the Container to update. 1410 """ 1411 1412 def update(self, *, body: "Dict[Literal['container'], Container]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1413 """Update attributes of an existing Container. 1414 1415 Required parameters: 1416 1417 * body: Dict[Literal['container'], Container] --- A dictionary with a single item `'container'`. 1418 Its value is a `Container` dictionary defining the attributes to set. 1419 1420 * uuid: str --- The UUID of the Container to update. 1421 1422 Optional parameters: 1423 1424 * select: Optional[List] --- An array of names of attributes to return in the response. 1425 """ 1426 1427 def update_priority(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1428 """Recalculate and return the priority of a given container. 1429 1430 Required parameters: 1431 1432 * uuid: str --- The UUID of the Container to update. 1433 """
Methods to query and manipulate Arvados containers
1284 def auth(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1285 """Get the API client authorization token associated with this container. 1286 1287 Required parameters: 1288 1289 * uuid: str --- The UUID of the Container to query. 1290 """
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]:
1292 def create(self, *, body: "Dict[Literal['container'], Container]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1293 """Create a new Container. 1294 1295 Required parameters: 1296 1297 * body: Dict[Literal['container'], Container] --- A dictionary with a single item `'container'`. 1298 Its value is a `Container` dictionary defining the attributes to set. 1299 1300 Optional parameters: 1301 1302 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1303 1304 * 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`. 1305 1306 * select: Optional[List] --- An array of names of attributes to return in the response. 1307 """
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.
1309 def current(self) -> 'ArvadosAPIRequest[Container]': 1310 """Return the container record associated with the API token authorizing this request."""
Return the container record associated with the API token authorizing this request.
1312 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1313 """Delete an existing Container. 1314 1315 Required parameters: 1316 1317 * uuid: str --- The UUID of the Container to delete. 1318 """
Delete an existing Container.
Required parameters:
- uuid: str — The UUID of the Container to delete.
1320 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1321 """Get a Container record by UUID. 1322 1323 Required parameters: 1324 1325 * uuid: str --- The UUID of the Container to return. 1326 1327 Optional parameters: 1328 1329 * select: Optional[List] --- An array of names of attributes to return in the response. 1330 """
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]:
1332 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]': 1333 """Retrieve a ContainerList. 1334 1335 This method returns a single page of `Container` objects that match your search 1336 criteria. If you just want to iterate all objects that match your search 1337 criteria, consider using `arvados.util.keyset_list_all`. 1338 1339 Optional parameters: 1340 1341 * bypass_federation: bool --- If true, do not return results from other clusters in the 1342 federation, only the cluster that received the request. 1343 You must be an administrator to use this flag. Default `False`. 1344 1345 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1346 1347 * count: str --- A string to determine result counting behavior. Supported values are: 1348 1349 * `"exact"`: The response will include an `items_available` field that 1350 counts the number of objects that matched this search criteria, 1351 including ones not included in `items`. 1352 1353 * `"none"`: The response will not include an `items_avaliable` 1354 field. This improves performance by returning a result as soon as enough 1355 `items` have been loaded for this result. 1356 1357 Default `'exact'`. 1358 1359 * distinct: bool --- If this is true, and multiple objects have the same values 1360 for the attributes that you specify in the `select` parameter, then each unique 1361 set of values will only be returned once in the result set. Default `False`. 1362 1363 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1364 Refer to the [filters reference][] for more information about how to write filters. 1365 1366 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1367 1368 * limit: int --- The maximum number of objects to return in the result. 1369 Note that the API may return fewer results than this if your request hits other 1370 limits set by the administrator. Default `100`. 1371 1372 * offset: int --- Return matching objects starting from this index. 1373 Note that result indexes may change if objects are modified in between a series 1374 of list calls. Default `0`. 1375 1376 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1377 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1378 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1379 1380 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1381 1382 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1383 The keys of this object are attribute names. 1384 Each value is either a single matching value or an array of matching values for that attribute. 1385 The `filters` parameter is more flexible and preferred. 1386 """
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.
1388 def lock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1389 """Lock a container (for a dispatcher to begin running it). 1390 1391 Required parameters: 1392 1393 * uuid: str --- The UUID of the Container to update. 1394 """
Lock a container (for a dispatcher to begin running it).
Required parameters:
- uuid: str — The UUID of the Container to update.
1396 def secret_mounts(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1397 """Return secret mount information for the container associated with the API token authorizing this request. 1398 1399 Required parameters: 1400 1401 * uuid: str --- The UUID of the Container to query. 1402 """
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.
1404 def unlock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1405 """Unlock a container (for a dispatcher to stop running it). 1406 1407 Required parameters: 1408 1409 * uuid: str --- The UUID of the Container to update. 1410 """
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]:
1412 def update(self, *, body: "Dict[Literal['container'], Container]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Container]': 1413 """Update attributes of an existing Container. 1414 1415 Required parameters: 1416 1417 * body: Dict[Literal['container'], Container] --- A dictionary with a single item `'container'`. 1418 Its value is a `Container` dictionary defining the attributes to set. 1419 1420 * uuid: str --- The UUID of the Container to update. 1421 1422 Optional parameters: 1423 1424 * select: Optional[List] --- An array of names of attributes to return in the response. 1425 """
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.
1427 def update_priority(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]': 1428 """Recalculate and return the priority of a given container. 1429 1430 Required parameters: 1431 1432 * uuid: str --- The UUID of the Container to update. 1433 """
Recalculate and return the priority of a given container.
Required parameters:
- uuid: str — The UUID of the Container to update.
class
Group(typing.TypedDict):
1436class Group(TypedDict, total=False): 1437 """Arvados group 1438 1439 Groups provide a way to organize users or data together, depending on their 1440 `group_class`. 1441 1442 This is the dictionary object that represents a single Group in Arvados 1443 and is returned by most `Groups` methods. 1444 The keys of the dictionary are documented below, along with their types. 1445 Not every key may appear in every dictionary returned by an API call. 1446 When a method doesn't return all the data, you can use its `select` parameter 1447 to list the specific keys you need. Refer to the API documentation for details. 1448 """ 1449 etag: 'str' 1450 """Object cache version.""" 1451 uuid: 'str' 1452 """This group's Arvados UUID, like `zzzzz-j7d0g-12345abcde67890`.""" 1453 owner_uuid: 'str' 1454 """The UUID of the user or group that owns this group.""" 1455 created_at: 'str' 1456 """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`.""" 1457 modified_by_user_uuid: 'str' 1458 """The UUID of the user that last updated this group.""" 1459 modified_at: 'str' 1460 """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`.""" 1461 name: 'str' 1462 """The name of this group assigned by a user.""" 1463 description: 'str' 1464 """A longer HTML description of this group assigned by a user. 1465 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 1466 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 1467 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 1468 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 1469 """ 1470 group_class: 'str' 1471 """A string representing which type of group this is. One of: 1472 1473 * `"filter"` --- A virtual project whose contents are selected dynamically by filters. 1474 * `"project"` --- An Arvados project that can contain collections, 1475 container records, workflows, and subprojects. 1476 * `"role"` --- A group of users that can be granted permissions in Arvados. 1477 """ 1478 trash_at: 'str' 1479 """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`.""" 1480 is_trashed: 'bool' 1481 """A boolean flag to indicate whether or not this group is trashed.""" 1482 delete_at: 'str' 1483 """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`.""" 1484 properties: 'Dict[str, Any]' 1485 """A hash of arbitrary metadata for this group. 1486 Some keys may be reserved by Arvados or defined by a configured vocabulary. 1487 Refer to the [metadata properties reference][] for details. 1488 1489 [metadata properties reference]: https://doc.arvados.org/api/properties.html 1490 """ 1491 frozen_by_uuid: 'str' 1492 """The UUID of the user that has frozen this group, if any. Frozen projects 1493 cannot have their contents or metadata changed, even by admins. 1494 """
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):
1497class GroupList(TypedDict, total=False): 1498 """A list of Group objects. 1499 1500 This is the dictionary object returned when you call `Groups.list`. 1501 If you just want to iterate all objects that match your search criteria, 1502 consider using `arvados.util.keyset_list_all`. 1503 If you work with this raw object, the keys of the dictionary are documented 1504 below, along with their types. The `items` key maps to a list of matching 1505 `Group` objects. 1506 """ 1507 kind: 'str' = 'arvados#groupList' 1508 """Object type. Always arvados#groupList.""" 1509 etag: 'str' 1510 """List cache version.""" 1511 items: 'List[Group]' 1512 """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:
1515class Groups: 1516 """Methods to query and manipulate Arvados groups""" 1517 1518 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]': 1519 """List objects that belong to a group. 1520 1521 Optional parameters: 1522 1523 * bypass_federation: bool --- If true, do not return results from other clusters in the 1524 federation, only the cluster that received the request. 1525 You must be an administrator to use this flag. Default `False`. 1526 1527 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1528 1529 * count: str --- A string to determine result counting behavior. Supported values are: 1530 1531 * `"exact"`: The response will include an `items_available` field that 1532 counts the number of objects that matched this search criteria, 1533 including ones not included in `items`. 1534 1535 * `"none"`: The response will not include an `items_avaliable` 1536 field. This improves performance by returning a result as soon as enough 1537 `items` have been loaded for this result. 1538 1539 Default `'exact'`. 1540 1541 * distinct: bool --- If this is true, and multiple objects have the same values 1542 for the attributes that you specify in the `select` parameter, then each unique 1543 set of values will only be returned once in the result set. Default `False`. 1544 1545 * exclude_home_project: bool --- If true, exclude contents of the user's home project from the listing. 1546 Calling this method with this flag set is how clients enumerate objects shared 1547 with the current user. Default `False`. 1548 1549 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1550 Refer to the [filters reference][] for more information about how to write filters. 1551 1552 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1553 1554 * include: Optional[List] --- An array of referenced objects to include in the `included` field of the response. Supported values in the array are: 1555 1556 * `"container_uuid"` 1557 * `"owner_uuid"` 1558 1559 1560 1561 * include_old_versions: bool --- If true, include past versions of collections in the listing. Default `False`. 1562 1563 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1564 1565 * limit: int --- The maximum number of objects to return in the result. 1566 Note that the API may return fewer results than this if your request hits other 1567 limits set by the administrator. Default `100`. 1568 1569 * offset: int --- Return matching objects starting from this index. 1570 Note that result indexes may change if objects are modified in between a series 1571 of list calls. Default `0`. 1572 1573 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1574 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1575 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1576 1577 * recursive: bool --- If true, include contents from child groups recursively. Default `False`. 1578 1579 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1580 1581 * uuid: str --- If given, limit the listing to objects owned by the 1582 user or group with this UUID. Default `''`. 1583 1584 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1585 The keys of this object are attribute names. 1586 Each value is either a single matching value or an array of matching values for that attribute. 1587 The `filters` parameter is more flexible and preferred. 1588 """ 1589 1590 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]': 1591 """Create a new Group. 1592 1593 Required parameters: 1594 1595 * body: Dict[Literal['group'], Group] --- A dictionary with a single item `'group'`. 1596 Its value is a `Group` dictionary defining the attributes to set. 1597 1598 Optional parameters: 1599 1600 * async: bool --- If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default `False`. 1601 1602 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1603 1604 * 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`. 1605 1606 * select: Optional[List] --- An array of names of attributes to return in the response. 1607 """ 1608 1609 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1610 """Delete an existing Group. 1611 1612 Required parameters: 1613 1614 * uuid: str --- The UUID of the Group to delete. 1615 """ 1616 1617 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1618 """Get a Group record by UUID. 1619 1620 Required parameters: 1621 1622 * uuid: str --- The UUID of the Group to return. 1623 1624 Optional parameters: 1625 1626 * include_trash: bool --- Return group/project even if its `is_trashed` attribute is true. Default `False`. 1627 1628 * select: Optional[List] --- An array of names of attributes to return in the response. 1629 """ 1630 1631 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]': 1632 """Retrieve a GroupList. 1633 1634 This method returns a single page of `Group` objects that match your search 1635 criteria. If you just want to iterate all objects that match your search 1636 criteria, consider using `arvados.util.keyset_list_all`. 1637 1638 Optional parameters: 1639 1640 * bypass_federation: bool --- If true, do not return results from other clusters in the 1641 federation, only the cluster that received the request. 1642 You must be an administrator to use this flag. Default `False`. 1643 1644 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1645 1646 * count: str --- A string to determine result counting behavior. Supported values are: 1647 1648 * `"exact"`: The response will include an `items_available` field that 1649 counts the number of objects that matched this search criteria, 1650 including ones not included in `items`. 1651 1652 * `"none"`: The response will not include an `items_avaliable` 1653 field. This improves performance by returning a result as soon as enough 1654 `items` have been loaded for this result. 1655 1656 Default `'exact'`. 1657 1658 * distinct: bool --- If this is true, and multiple objects have the same values 1659 for the attributes that you specify in the `select` parameter, then each unique 1660 set of values will only be returned once in the result set. Default `False`. 1661 1662 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1663 Refer to the [filters reference][] for more information about how to write filters. 1664 1665 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1666 1667 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1668 1669 * limit: int --- The maximum number of objects to return in the result. 1670 Note that the API may return fewer results than this if your request hits other 1671 limits set by the administrator. Default `100`. 1672 1673 * offset: int --- Return matching objects starting from this index. 1674 Note that result indexes may change if objects are modified in between a series 1675 of list calls. Default `0`. 1676 1677 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1678 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1679 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1680 1681 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1682 1683 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1684 The keys of this object are attribute names. 1685 Each value is either a single matching value or an array of matching values for that attribute. 1686 The `filters` parameter is more flexible and preferred. 1687 """ 1688 1689 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]': 1690 """List groups that the current user can access via permission links. 1691 1692 Optional parameters: 1693 1694 * bypass_federation: bool --- If true, do not return results from other clusters in the 1695 federation, only the cluster that received the request. 1696 You must be an administrator to use this flag. Default `False`. 1697 1698 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1699 1700 * count: str --- A string to determine result counting behavior. Supported values are: 1701 1702 * `"exact"`: The response will include an `items_available` field that 1703 counts the number of objects that matched this search criteria, 1704 including ones not included in `items`. 1705 1706 * `"none"`: The response will not include an `items_avaliable` 1707 field. This improves performance by returning a result as soon as enough 1708 `items` have been loaded for this result. 1709 1710 Default `'exact'`. 1711 1712 * distinct: bool --- If this is true, and multiple objects have the same values 1713 for the attributes that you specify in the `select` parameter, then each unique 1714 set of values will only be returned once in the result set. Default `False`. 1715 1716 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1717 Refer to the [filters reference][] for more information about how to write filters. 1718 1719 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1720 1721 * include: Optional[str] --- A string naming referenced objects to include in the `included` field of the response. Supported values are: 1722 1723 * `"owner_uuid"` 1724 1725 1726 1727 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1728 1729 * limit: int --- The maximum number of objects to return in the result. 1730 Note that the API may return fewer results than this if your request hits other 1731 limits set by the administrator. Default `100`. 1732 1733 * offset: int --- Return matching objects starting from this index. 1734 Note that result indexes may change if objects are modified in between a series 1735 of list calls. Default `0`. 1736 1737 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1738 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1739 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1740 1741 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1742 1743 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1744 The keys of this object are attribute names. 1745 Each value is either a single matching value or an array of matching values for that attribute. 1746 The `filters` parameter is more flexible and preferred. 1747 """ 1748 1749 def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1750 """Trash a group. 1751 1752 Required parameters: 1753 1754 * uuid: str --- The UUID of the Group to update. 1755 """ 1756 1757 def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1758 """Untrash a group. 1759 1760 Required parameters: 1761 1762 * uuid: str --- The UUID of the Group to update. 1763 """ 1764 1765 def update(self, *, body: "Dict[Literal['group'], Group]", uuid: 'str', async_: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1766 """Update attributes of an existing Group. 1767 1768 Required parameters: 1769 1770 * body: Dict[Literal['group'], Group] --- A dictionary with a single item `'group'`. 1771 Its value is a `Group` dictionary defining the attributes to set. 1772 1773 * uuid: str --- The UUID of the Group to update. 1774 1775 Optional parameters: 1776 1777 * async: bool --- If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default `False`. 1778 1779 * select: Optional[List] --- An array of names of attributes to return in the response. 1780 """
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]:
1518 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]': 1519 """List objects that belong to a group. 1520 1521 Optional parameters: 1522 1523 * bypass_federation: bool --- If true, do not return results from other clusters in the 1524 federation, only the cluster that received the request. 1525 You must be an administrator to use this flag. Default `False`. 1526 1527 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1528 1529 * count: str --- A string to determine result counting behavior. Supported values are: 1530 1531 * `"exact"`: The response will include an `items_available` field that 1532 counts the number of objects that matched this search criteria, 1533 including ones not included in `items`. 1534 1535 * `"none"`: The response will not include an `items_avaliable` 1536 field. This improves performance by returning a result as soon as enough 1537 `items` have been loaded for this result. 1538 1539 Default `'exact'`. 1540 1541 * distinct: bool --- If this is true, and multiple objects have the same values 1542 for the attributes that you specify in the `select` parameter, then each unique 1543 set of values will only be returned once in the result set. Default `False`. 1544 1545 * exclude_home_project: bool --- If true, exclude contents of the user's home project from the listing. 1546 Calling this method with this flag set is how clients enumerate objects shared 1547 with the current user. Default `False`. 1548 1549 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1550 Refer to the [filters reference][] for more information about how to write filters. 1551 1552 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1553 1554 * include: Optional[List] --- An array of referenced objects to include in the `included` field of the response. Supported values in the array are: 1555 1556 * `"container_uuid"` 1557 * `"owner_uuid"` 1558 1559 1560 1561 * include_old_versions: bool --- If true, include past versions of collections in the listing. Default `False`. 1562 1563 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1564 1565 * limit: int --- The maximum number of objects to return in the result. 1566 Note that the API may return fewer results than this if your request hits other 1567 limits set by the administrator. Default `100`. 1568 1569 * offset: int --- Return matching objects starting from this index. 1570 Note that result indexes may change if objects are modified in between a series 1571 of list calls. Default `0`. 1572 1573 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1574 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1575 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1576 1577 * recursive: bool --- If true, include contents from child groups recursively. Default `False`. 1578 1579 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1580 1581 * uuid: str --- If given, limit the listing to objects owned by the 1582 user or group with this UUID. Default `''`. 1583 1584 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1585 The keys of this object are attribute names. 1586 Each value is either a single matching value or an array of matching values for that attribute. 1587 The `filters` parameter is more flexible and preferred. 1588 """
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]:
1590 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]': 1591 """Create a new Group. 1592 1593 Required parameters: 1594 1595 * body: Dict[Literal['group'], Group] --- A dictionary with a single item `'group'`. 1596 Its value is a `Group` dictionary defining the attributes to set. 1597 1598 Optional parameters: 1599 1600 * async: bool --- If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default `False`. 1601 1602 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1603 1604 * 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`. 1605 1606 * select: Optional[List] --- An array of names of attributes to return in the response. 1607 """
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.
1609 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1610 """Delete an existing Group. 1611 1612 Required parameters: 1613 1614 * uuid: str --- The UUID of the Group to delete. 1615 """
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]:
1617 def get(self, *, uuid: 'str', include_trash: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1618 """Get a Group record by UUID. 1619 1620 Required parameters: 1621 1622 * uuid: str --- The UUID of the Group to return. 1623 1624 Optional parameters: 1625 1626 * include_trash: bool --- Return group/project even if its `is_trashed` attribute is true. Default `False`. 1627 1628 * select: Optional[List] --- An array of names of attributes to return in the response. 1629 """
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]:
1631 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]': 1632 """Retrieve a GroupList. 1633 1634 This method returns a single page of `Group` objects that match your search 1635 criteria. If you just want to iterate all objects that match your search 1636 criteria, consider using `arvados.util.keyset_list_all`. 1637 1638 Optional parameters: 1639 1640 * bypass_federation: bool --- If true, do not return results from other clusters in the 1641 federation, only the cluster that received the request. 1642 You must be an administrator to use this flag. Default `False`. 1643 1644 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1645 1646 * count: str --- A string to determine result counting behavior. Supported values are: 1647 1648 * `"exact"`: The response will include an `items_available` field that 1649 counts the number of objects that matched this search criteria, 1650 including ones not included in `items`. 1651 1652 * `"none"`: The response will not include an `items_avaliable` 1653 field. This improves performance by returning a result as soon as enough 1654 `items` have been loaded for this result. 1655 1656 Default `'exact'`. 1657 1658 * distinct: bool --- If this is true, and multiple objects have the same values 1659 for the attributes that you specify in the `select` parameter, then each unique 1660 set of values will only be returned once in the result set. Default `False`. 1661 1662 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1663 Refer to the [filters reference][] for more information about how to write filters. 1664 1665 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1666 1667 * include_trash: bool --- Include items whose `is_trashed` attribute is true. Default `False`. 1668 1669 * limit: int --- The maximum number of objects to return in the result. 1670 Note that the API may return fewer results than this if your request hits other 1671 limits set by the administrator. Default `100`. 1672 1673 * offset: int --- Return matching objects starting from this index. 1674 Note that result indexes may change if objects are modified in between a series 1675 of list calls. Default `0`. 1676 1677 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1678 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1679 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1680 1681 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1682 1683 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1684 The keys of this object are attribute names. 1685 Each value is either a single matching value or an array of matching values for that attribute. 1686 The `filters` parameter is more flexible and preferred. 1687 """
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.
1749 def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1750 """Trash a group. 1751 1752 Required parameters: 1753 1754 * uuid: str --- The UUID of the Group to update. 1755 """
Trash a group.
Required parameters:
- uuid: str — The UUID of the Group to update.
1757 def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]': 1758 """Untrash a group. 1759 1760 Required parameters: 1761 1762 * uuid: str --- The UUID of the Group to update. 1763 """
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]:
1765 def update(self, *, body: "Dict[Literal['group'], Group]", uuid: 'str', async_: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Group]': 1766 """Update attributes of an existing Group. 1767 1768 Required parameters: 1769 1770 * body: Dict[Literal['group'], Group] --- A dictionary with a single item `'group'`. 1771 Its value is a `Group` dictionary defining the attributes to set. 1772 1773 * uuid: str --- The UUID of the Group to update. 1774 1775 Optional parameters: 1776 1777 * async: bool --- If true, cluster permission will not be updated immediately, but instead at the next configured update interval. Default `False`. 1778 1779 * select: Optional[List] --- An array of names of attributes to return in the response. 1780 """
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):
1783class KeepService(TypedDict, total=False): 1784 """Arvados Keep service 1785 1786 This resource stores information about a single Keep service in this Arvados 1787 cluster that clients can contact to retrieve and store data. 1788 1789 This is the dictionary object that represents a single KeepService in Arvados 1790 and is returned by most `KeepServices` methods. 1791 The keys of the dictionary are documented below, along with their types. 1792 Not every key may appear in every dictionary returned by an API call. 1793 When a method doesn't return all the data, you can use its `select` parameter 1794 to list the specific keys you need. Refer to the API documentation for details. 1795 """ 1796 etag: 'str' 1797 """Object cache version.""" 1798 uuid: 'str' 1799 """This Keep service's Arvados UUID, like `zzzzz-bi6l4-12345abcde67890`.""" 1800 owner_uuid: 'str' 1801 """The UUID of the user or group that owns this Keep service.""" 1802 modified_by_user_uuid: 'str' 1803 """The UUID of the user that last updated this Keep service.""" 1804 modified_at: 'str' 1805 """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`.""" 1806 service_host: 'str' 1807 """The DNS hostname of this Keep service.""" 1808 service_port: 'int' 1809 """The TCP port where this Keep service listens.""" 1810 service_ssl_flag: 'bool' 1811 """A boolean flag that indicates whether or not this Keep service uses TLS/SSL.""" 1812 service_type: 'str' 1813 """A string that describes which type of Keep service this is. One of: 1814 1815 * `"disk"` --- A service that stores blocks on a local filesystem. 1816 * `"blob"` --- A service that stores blocks in a cloud object store. 1817 * `"proxy"` --- A keepproxy service. 1818 """ 1819 created_at: 'str' 1820 """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`.""" 1821 read_only: 'bool' 1822 """A boolean flag. If set, this Keep service does not accept requests to write data 1823 blocks; it only serves blocks it already has. 1824 """
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):
1827class KeepServiceList(TypedDict, total=False): 1828 """A list of KeepService objects. 1829 1830 This is the dictionary object returned when you call `KeepServices.list`. 1831 If you just want to iterate all objects that match your search criteria, 1832 consider using `arvados.util.keyset_list_all`. 1833 If you work with this raw object, the keys of the dictionary are documented 1834 below, along with their types. The `items` key maps to a list of matching 1835 `KeepService` objects. 1836 """ 1837 kind: 'str' = 'arvados#keepServiceList' 1838 """Object type. Always arvados#keepServiceList.""" 1839 etag: 'str' 1840 """List cache version.""" 1841 items: 'List[KeepService]' 1842 """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:
1845class KeepServices: 1846 """Methods to query and manipulate Arvados keep services""" 1847 1848 def accessible(self) -> 'ArvadosAPIRequest[KeepService]': 1849 """List Keep services that the current client can access.""" 1850 1851 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]': 1852 """Create a new KeepService. 1853 1854 Required parameters: 1855 1856 * body: Dict[Literal['keep_service'], KeepService] --- A dictionary with a single item `'keep_service'`. 1857 Its value is a `KeepService` dictionary defining the attributes to set. 1858 1859 Optional parameters: 1860 1861 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1862 1863 * 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`. 1864 1865 * select: Optional[List] --- An array of names of attributes to return in the response. 1866 """ 1867 1868 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[KeepService]': 1869 """Delete an existing KeepService. 1870 1871 Required parameters: 1872 1873 * uuid: str --- The UUID of the KeepService to delete. 1874 """ 1875 1876 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1877 """Get a KeepService record by UUID. 1878 1879 Required parameters: 1880 1881 * uuid: str --- The UUID of the KeepService to return. 1882 1883 Optional parameters: 1884 1885 * select: Optional[List] --- An array of names of attributes to return in the response. 1886 """ 1887 1888 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]': 1889 """Retrieve a KeepServiceList. 1890 1891 This method returns a single page of `KeepService` objects that match your search 1892 criteria. If you just want to iterate all objects that match your search 1893 criteria, consider using `arvados.util.keyset_list_all`. 1894 1895 Optional parameters: 1896 1897 * bypass_federation: bool --- If true, do not return results from other clusters in the 1898 federation, only the cluster that received the request. 1899 You must be an administrator to use this flag. Default `False`. 1900 1901 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1902 1903 * count: str --- A string to determine result counting behavior. Supported values are: 1904 1905 * `"exact"`: The response will include an `items_available` field that 1906 counts the number of objects that matched this search criteria, 1907 including ones not included in `items`. 1908 1909 * `"none"`: The response will not include an `items_avaliable` 1910 field. This improves performance by returning a result as soon as enough 1911 `items` have been loaded for this result. 1912 1913 Default `'exact'`. 1914 1915 * distinct: bool --- If this is true, and multiple objects have the same values 1916 for the attributes that you specify in the `select` parameter, then each unique 1917 set of values will only be returned once in the result set. Default `False`. 1918 1919 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1920 Refer to the [filters reference][] for more information about how to write filters. 1921 1922 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1923 1924 * limit: int --- The maximum number of objects to return in the result. 1925 Note that the API may return fewer results than this if your request hits other 1926 limits set by the administrator. Default `100`. 1927 1928 * offset: int --- Return matching objects starting from this index. 1929 Note that result indexes may change if objects are modified in between a series 1930 of list calls. Default `0`. 1931 1932 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1933 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1934 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1935 1936 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1937 1938 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1939 The keys of this object are attribute names. 1940 Each value is either a single matching value or an array of matching values for that attribute. 1941 The `filters` parameter is more flexible and preferred. 1942 """ 1943 1944 def update(self, *, body: "Dict[Literal['keep_service'], KeepService]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1945 """Update attributes of an existing KeepService. 1946 1947 Required parameters: 1948 1949 * body: Dict[Literal['keep_service'], KeepService] --- A dictionary with a single item `'keep_service'`. 1950 Its value is a `KeepService` dictionary defining the attributes to set. 1951 1952 * uuid: str --- The UUID of the KeepService to update. 1953 1954 Optional parameters: 1955 1956 * select: Optional[List] --- An array of names of attributes to return in the response. 1957 """
Methods to query and manipulate Arvados keep services
1848 def accessible(self) -> 'ArvadosAPIRequest[KeepService]': 1849 """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]:
1851 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]': 1852 """Create a new KeepService. 1853 1854 Required parameters: 1855 1856 * body: Dict[Literal['keep_service'], KeepService] --- A dictionary with a single item `'keep_service'`. 1857 Its value is a `KeepService` dictionary defining the attributes to set. 1858 1859 Optional parameters: 1860 1861 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 1862 1863 * 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`. 1864 1865 * select: Optional[List] --- An array of names of attributes to return in the response. 1866 """
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.
1868 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[KeepService]': 1869 """Delete an existing KeepService. 1870 1871 Required parameters: 1872 1873 * uuid: str --- The UUID of the KeepService to delete. 1874 """
Delete an existing KeepService.
Required parameters:
- uuid: str — The UUID of the KeepService to delete.
1876 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1877 """Get a KeepService record by UUID. 1878 1879 Required parameters: 1880 1881 * uuid: str --- The UUID of the KeepService to return. 1882 1883 Optional parameters: 1884 1885 * select: Optional[List] --- An array of names of attributes to return in the response. 1886 """
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]:
1888 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]': 1889 """Retrieve a KeepServiceList. 1890 1891 This method returns a single page of `KeepService` objects that match your search 1892 criteria. If you just want to iterate all objects that match your search 1893 criteria, consider using `arvados.util.keyset_list_all`. 1894 1895 Optional parameters: 1896 1897 * bypass_federation: bool --- If true, do not return results from other clusters in the 1898 federation, only the cluster that received the request. 1899 You must be an administrator to use this flag. Default `False`. 1900 1901 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 1902 1903 * count: str --- A string to determine result counting behavior. Supported values are: 1904 1905 * `"exact"`: The response will include an `items_available` field that 1906 counts the number of objects that matched this search criteria, 1907 including ones not included in `items`. 1908 1909 * `"none"`: The response will not include an `items_avaliable` 1910 field. This improves performance by returning a result as soon as enough 1911 `items` have been loaded for this result. 1912 1913 Default `'exact'`. 1914 1915 * distinct: bool --- If this is true, and multiple objects have the same values 1916 for the attributes that you specify in the `select` parameter, then each unique 1917 set of values will only be returned once in the result set. Default `False`. 1918 1919 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 1920 Refer to the [filters reference][] for more information about how to write filters. 1921 1922 [filters reference]: https://doc.arvados.org/api/methods.html#filters 1923 1924 * limit: int --- The maximum number of objects to return in the result. 1925 Note that the API may return fewer results than this if your request hits other 1926 limits set by the administrator. Default `100`. 1927 1928 * offset: int --- Return matching objects starting from this index. 1929 Note that result indexes may change if objects are modified in between a series 1930 of list calls. Default `0`. 1931 1932 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 1933 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 1934 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 1935 1936 * select: Optional[List] --- An array of names of attributes to return from each matching object. 1937 1938 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 1939 The keys of this object are attribute names. 1940 Each value is either a single matching value or an array of matching values for that attribute. 1941 The `filters` parameter is more flexible and preferred. 1942 """
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]:
1944 def update(self, *, body: "Dict[Literal['keep_service'], KeepService]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[KeepService]': 1945 """Update attributes of an existing KeepService. 1946 1947 Required parameters: 1948 1949 * body: Dict[Literal['keep_service'], KeepService] --- A dictionary with a single item `'keep_service'`. 1950 Its value is a `KeepService` dictionary defining the attributes to set. 1951 1952 * uuid: str --- The UUID of the KeepService to update. 1953 1954 Optional parameters: 1955 1956 * select: Optional[List] --- An array of names of attributes to return in the response. 1957 """
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):
1960class Link(TypedDict, total=False): 1961 """Arvados object link 1962 1963 A link provides a way to define relationships between Arvados objects, 1964 depending on their `link_class`. 1965 1966 This is the dictionary object that represents a single Link in Arvados 1967 and is returned by most `Links` methods. 1968 The keys of the dictionary are documented below, along with their types. 1969 Not every key may appear in every dictionary returned by an API call. 1970 When a method doesn't return all the data, you can use its `select` parameter 1971 to list the specific keys you need. Refer to the API documentation for details. 1972 """ 1973 etag: 'str' 1974 """Object cache version.""" 1975 uuid: 'str' 1976 """This link's Arvados UUID, like `zzzzz-o0j2j-12345abcde67890`.""" 1977 owner_uuid: 'str' 1978 """The UUID of the user or group that owns this link.""" 1979 created_at: 'str' 1980 """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`.""" 1981 modified_by_user_uuid: 'str' 1982 """The UUID of the user that last updated this link.""" 1983 modified_at: 'str' 1984 """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`.""" 1985 tail_uuid: 'str' 1986 """The UUID of the Arvados object that is the target of this relationship.""" 1987 link_class: 'str' 1988 """A string that defines which kind of link this is. One of: 1989 1990 * `"permission"` --- This link grants a permission to the user or group 1991 referenced by `head_uuid` to the object referenced by `tail_uuid`. The 1992 access level is set by `name`. 1993 * `"star"` --- This link represents a "favorite." The user referenced 1994 by `head_uuid` wants quick access to the object referenced by `tail_uuid`. 1995 * `"tag"` --- This link represents an unstructured metadata tag. The object 1996 referenced by `tail_uuid` has the tag defined by `name`. 1997 """ 1998 name: 'str' 1999 """The primary value of this link. For `"permission"` links, this is one of 2000 `"can_read"`, `"can_write"`, or `"can_manage"`. 2001 """ 2002 head_uuid: 'str' 2003 """The UUID of the Arvados object that is the originator or actor in this 2004 relationship. May be null. 2005 """ 2006 properties: 'Dict[str, Any]' 2007 """A hash of arbitrary metadata for this link. 2008 Some keys may be reserved by Arvados or defined by a configured vocabulary. 2009 Refer to the [metadata properties reference][] for details. 2010 2011 [metadata properties reference]: https://doc.arvados.org/api/properties.html 2012 """
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):
2015class LinkList(TypedDict, total=False): 2016 """A list of Link objects. 2017 2018 This is the dictionary object returned when you call `Links.list`. 2019 If you just want to iterate all objects that match your search criteria, 2020 consider using `arvados.util.keyset_list_all`. 2021 If you work with this raw object, the keys of the dictionary are documented 2022 below, along with their types. The `items` key maps to a list of matching 2023 `Link` objects. 2024 """ 2025 kind: 'str' = 'arvados#linkList' 2026 """Object type. Always arvados#linkList.""" 2027 etag: 'str' 2028 """List cache version.""" 2029 items: 'List[Link]' 2030 """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:
2033class Links: 2034 """Methods to query and manipulate Arvados links""" 2035 2036 def create(self, *, body: "Dict[Literal['link'], Link]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2037 """Create a new Link. 2038 2039 Required parameters: 2040 2041 * body: Dict[Literal['link'], Link] --- A dictionary with a single item `'link'`. 2042 Its value is a `Link` dictionary defining the attributes to set. 2043 2044 Optional parameters: 2045 2046 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2047 2048 * 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`. 2049 2050 * select: Optional[List] --- An array of names of attributes to return in the response. 2051 """ 2052 2053 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]': 2054 """Delete an existing Link. 2055 2056 Required parameters: 2057 2058 * uuid: str --- The UUID of the Link to delete. 2059 """ 2060 2061 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2062 """Get a Link record by UUID. 2063 2064 Required parameters: 2065 2066 * uuid: str --- The UUID of the Link to return. 2067 2068 Optional parameters: 2069 2070 * select: Optional[List] --- An array of names of attributes to return in the response. 2071 """ 2072 2073 def get_permissions(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]': 2074 """List permissions granted on an Arvados object. 2075 2076 Required parameters: 2077 2078 * uuid: str --- The UUID of the Link to query. 2079 """ 2080 2081 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]': 2082 """Retrieve a LinkList. 2083 2084 This method returns a single page of `Link` objects that match your search 2085 criteria. If you just want to iterate all objects that match your search 2086 criteria, consider using `arvados.util.keyset_list_all`. 2087 2088 Optional parameters: 2089 2090 * bypass_federation: bool --- If true, do not return results from other clusters in the 2091 federation, only the cluster that received the request. 2092 You must be an administrator to use this flag. Default `False`. 2093 2094 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2095 2096 * count: str --- A string to determine result counting behavior. Supported values are: 2097 2098 * `"exact"`: The response will include an `items_available` field that 2099 counts the number of objects that matched this search criteria, 2100 including ones not included in `items`. 2101 2102 * `"none"`: The response will not include an `items_avaliable` 2103 field. This improves performance by returning a result as soon as enough 2104 `items` have been loaded for this result. 2105 2106 Default `'exact'`. 2107 2108 * distinct: bool --- If this is true, and multiple objects have the same values 2109 for the attributes that you specify in the `select` parameter, then each unique 2110 set of values will only be returned once in the result set. Default `False`. 2111 2112 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2113 Refer to the [filters reference][] for more information about how to write filters. 2114 2115 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2116 2117 * limit: int --- The maximum number of objects to return in the result. 2118 Note that the API may return fewer results than this if your request hits other 2119 limits set by the administrator. Default `100`. 2120 2121 * offset: int --- Return matching objects starting from this index. 2122 Note that result indexes may change if objects are modified in between a series 2123 of list calls. Default `0`. 2124 2125 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2126 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2127 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2128 2129 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2130 2131 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2132 The keys of this object are attribute names. 2133 Each value is either a single matching value or an array of matching values for that attribute. 2134 The `filters` parameter is more flexible and preferred. 2135 """ 2136 2137 def update(self, *, body: "Dict[Literal['link'], Link]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2138 """Update attributes of an existing Link. 2139 2140 Required parameters: 2141 2142 * body: Dict[Literal['link'], Link] --- A dictionary with a single item `'link'`. 2143 Its value is a `Link` dictionary defining the attributes to set. 2144 2145 * uuid: str --- The UUID of the Link to update. 2146 2147 Optional parameters: 2148 2149 * select: Optional[List] --- An array of names of attributes to return in the response. 2150 """
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]:
2036 def create(self, *, body: "Dict[Literal['link'], Link]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2037 """Create a new Link. 2038 2039 Required parameters: 2040 2041 * body: Dict[Literal['link'], Link] --- A dictionary with a single item `'link'`. 2042 Its value is a `Link` dictionary defining the attributes to set. 2043 2044 Optional parameters: 2045 2046 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2047 2048 * 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`. 2049 2050 * select: Optional[List] --- An array of names of attributes to return in the response. 2051 """
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.
2053 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]': 2054 """Delete an existing Link. 2055 2056 Required parameters: 2057 2058 * uuid: str --- The UUID of the Link to delete. 2059 """
Delete an existing Link.
Required parameters:
- uuid: str — The UUID of the Link to delete.
2061 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2062 """Get a Link record by UUID. 2063 2064 Required parameters: 2065 2066 * uuid: str --- The UUID of the Link to return. 2067 2068 Optional parameters: 2069 2070 * select: Optional[List] --- An array of names of attributes to return in the response. 2071 """
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.
2073 def get_permissions(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]': 2074 """List permissions granted on an Arvados object. 2075 2076 Required parameters: 2077 2078 * uuid: str --- The UUID of the Link to query. 2079 """
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]:
2081 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]': 2082 """Retrieve a LinkList. 2083 2084 This method returns a single page of `Link` objects that match your search 2085 criteria. If you just want to iterate all objects that match your search 2086 criteria, consider using `arvados.util.keyset_list_all`. 2087 2088 Optional parameters: 2089 2090 * bypass_federation: bool --- If true, do not return results from other clusters in the 2091 federation, only the cluster that received the request. 2092 You must be an administrator to use this flag. Default `False`. 2093 2094 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2095 2096 * count: str --- A string to determine result counting behavior. Supported values are: 2097 2098 * `"exact"`: The response will include an `items_available` field that 2099 counts the number of objects that matched this search criteria, 2100 including ones not included in `items`. 2101 2102 * `"none"`: The response will not include an `items_avaliable` 2103 field. This improves performance by returning a result as soon as enough 2104 `items` have been loaded for this result. 2105 2106 Default `'exact'`. 2107 2108 * distinct: bool --- If this is true, and multiple objects have the same values 2109 for the attributes that you specify in the `select` parameter, then each unique 2110 set of values will only be returned once in the result set. Default `False`. 2111 2112 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2113 Refer to the [filters reference][] for more information about how to write filters. 2114 2115 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2116 2117 * limit: int --- The maximum number of objects to return in the result. 2118 Note that the API may return fewer results than this if your request hits other 2119 limits set by the administrator. Default `100`. 2120 2121 * offset: int --- Return matching objects starting from this index. 2122 Note that result indexes may change if objects are modified in between a series 2123 of list calls. Default `0`. 2124 2125 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2126 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2127 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2128 2129 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2130 2131 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2132 The keys of this object are attribute names. 2133 Each value is either a single matching value or an array of matching values for that attribute. 2134 The `filters` parameter is more flexible and preferred. 2135 """
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]:
2137 def update(self, *, body: "Dict[Literal['link'], Link]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Link]': 2138 """Update attributes of an existing Link. 2139 2140 Required parameters: 2141 2142 * body: Dict[Literal['link'], Link] --- A dictionary with a single item `'link'`. 2143 Its value is a `Link` dictionary defining the attributes to set. 2144 2145 * uuid: str --- The UUID of the Link to update. 2146 2147 Optional parameters: 2148 2149 * select: Optional[List] --- An array of names of attributes to return in the response. 2150 """
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):
2153class Log(TypedDict, total=False): 2154 """Arvados log record 2155 2156 This resource represents a single log record about an event in this Arvados 2157 cluster. Some individual Arvados services create log records. Users can also 2158 create custom logs. 2159 2160 This is the dictionary object that represents a single Log in Arvados 2161 and is returned by most `Logs` methods. 2162 The keys of the dictionary are documented below, along with their types. 2163 Not every key may appear in every dictionary returned by an API call. 2164 When a method doesn't return all the data, you can use its `select` parameter 2165 to list the specific keys you need. Refer to the API documentation for details. 2166 """ 2167 etag: 'str' 2168 """Object cache version.""" 2169 id: 'int' 2170 """The serial number of this log. You can use this in filters to query logs 2171 that were created before/after another. 2172 """ 2173 uuid: 'str' 2174 """This log's Arvados UUID, like `zzzzz-57u5n-12345abcde67890`.""" 2175 owner_uuid: 'str' 2176 """The UUID of the user or group that owns this log.""" 2177 modified_by_user_uuid: 'str' 2178 """The UUID of the user that last updated this log.""" 2179 object_uuid: 'str' 2180 """The UUID of the Arvados object that this log pertains to, such as a user 2181 or container. 2182 """ 2183 event_at: 'str' 2184 """The string encodes a UTC date and time in ISO 8601 format. Pass this to `ciso8601.parse_datetime` to build a `datetime.datetime`.""" 2185 event_type: 'str' 2186 """An arbitrary short string that classifies what type of log this is.""" 2187 summary: 'str' 2188 """A text string that describes the logged event. This is the primary 2189 attribute for simple logs. 2190 """ 2191 properties: 'Dict[str, Any]' 2192 """A hash of arbitrary metadata for this log. 2193 Some keys may be reserved by Arvados or defined by a configured vocabulary. 2194 Refer to the [metadata properties reference][] for details. 2195 2196 [metadata properties reference]: https://doc.arvados.org/api/properties.html 2197 """ 2198 created_at: 'str' 2199 """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`.""" 2200 modified_at: 'str' 2201 """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`.""" 2202 object_owner_uuid: 'str' 2203 """The `owner_uuid` of the object referenced by `object_uuid` at the time 2204 this log was created. 2205 """
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):
2208class LogList(TypedDict, total=False): 2209 """A list of Log objects. 2210 2211 This is the dictionary object returned when you call `Logs.list`. 2212 If you just want to iterate all objects that match your search criteria, 2213 consider using `arvados.util.keyset_list_all`. 2214 If you work with this raw object, the keys of the dictionary are documented 2215 below, along with their types. The `items` key maps to a list of matching 2216 `Log` objects. 2217 """ 2218 kind: 'str' = 'arvados#logList' 2219 """Object type. Always arvados#logList.""" 2220 etag: 'str' 2221 """List cache version.""" 2222 items: 'List[Log]' 2223 """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:
2226class Logs: 2227 """Methods to query and manipulate Arvados logs""" 2228 2229 def create(self, *, body: "Dict[Literal['log'], Log]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2230 """Create a new Log. 2231 2232 Required parameters: 2233 2234 * body: Dict[Literal['log'], Log] --- A dictionary with a single item `'log'`. 2235 Its value is a `Log` dictionary defining the attributes to set. 2236 2237 Optional parameters: 2238 2239 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2240 2241 * 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`. 2242 2243 * select: Optional[List] --- An array of names of attributes to return in the response. 2244 """ 2245 2246 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Log]': 2247 """Delete an existing Log. 2248 2249 Required parameters: 2250 2251 * uuid: str --- The UUID of the Log to delete. 2252 """ 2253 2254 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2255 """Get a Log record by UUID. 2256 2257 Required parameters: 2258 2259 * uuid: str --- The UUID of the Log to return. 2260 2261 Optional parameters: 2262 2263 * select: Optional[List] --- An array of names of attributes to return in the response. 2264 """ 2265 2266 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]': 2267 """Retrieve a LogList. 2268 2269 This method returns a single page of `Log` objects that match your search 2270 criteria. If you just want to iterate all objects that match your search 2271 criteria, consider using `arvados.util.keyset_list_all`. 2272 2273 Optional parameters: 2274 2275 * bypass_federation: bool --- If true, do not return results from other clusters in the 2276 federation, only the cluster that received the request. 2277 You must be an administrator to use this flag. Default `False`. 2278 2279 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2280 2281 * count: str --- A string to determine result counting behavior. Supported values are: 2282 2283 * `"exact"`: The response will include an `items_available` field that 2284 counts the number of objects that matched this search criteria, 2285 including ones not included in `items`. 2286 2287 * `"none"`: The response will not include an `items_avaliable` 2288 field. This improves performance by returning a result as soon as enough 2289 `items` have been loaded for this result. 2290 2291 Default `'exact'`. 2292 2293 * distinct: bool --- If this is true, and multiple objects have the same values 2294 for the attributes that you specify in the `select` parameter, then each unique 2295 set of values will only be returned once in the result set. Default `False`. 2296 2297 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2298 Refer to the [filters reference][] for more information about how to write filters. 2299 2300 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2301 2302 * limit: int --- The maximum number of objects to return in the result. 2303 Note that the API may return fewer results than this if your request hits other 2304 limits set by the administrator. Default `100`. 2305 2306 * offset: int --- Return matching objects starting from this index. 2307 Note that result indexes may change if objects are modified in between a series 2308 of list calls. Default `0`. 2309 2310 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2311 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2312 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2313 2314 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2315 2316 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2317 The keys of this object are attribute names. 2318 Each value is either a single matching value or an array of matching values for that attribute. 2319 The `filters` parameter is more flexible and preferred. 2320 """ 2321 2322 def update(self, *, body: "Dict[Literal['log'], Log]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2323 """Update attributes of an existing Log. 2324 2325 Required parameters: 2326 2327 * body: Dict[Literal['log'], Log] --- A dictionary with a single item `'log'`. 2328 Its value is a `Log` dictionary defining the attributes to set. 2329 2330 * uuid: str --- The UUID of the Log to update. 2331 2332 Optional parameters: 2333 2334 * select: Optional[List] --- An array of names of attributes to return in the response. 2335 """
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]:
2229 def create(self, *, body: "Dict[Literal['log'], Log]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2230 """Create a new Log. 2231 2232 Required parameters: 2233 2234 * body: Dict[Literal['log'], Log] --- A dictionary with a single item `'log'`. 2235 Its value is a `Log` dictionary defining the attributes to set. 2236 2237 Optional parameters: 2238 2239 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2240 2241 * 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`. 2242 2243 * select: Optional[List] --- An array of names of attributes to return in the response. 2244 """
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.
2246 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Log]': 2247 """Delete an existing Log. 2248 2249 Required parameters: 2250 2251 * uuid: str --- The UUID of the Log to delete. 2252 """
Delete an existing Log.
Required parameters:
- uuid: str — The UUID of the Log to delete.
2254 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2255 """Get a Log record by UUID. 2256 2257 Required parameters: 2258 2259 * uuid: str --- The UUID of the Log to return. 2260 2261 Optional parameters: 2262 2263 * select: Optional[List] --- An array of names of attributes to return in the response. 2264 """
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]:
2266 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]': 2267 """Retrieve a LogList. 2268 2269 This method returns a single page of `Log` objects that match your search 2270 criteria. If you just want to iterate all objects that match your search 2271 criteria, consider using `arvados.util.keyset_list_all`. 2272 2273 Optional parameters: 2274 2275 * bypass_federation: bool --- If true, do not return results from other clusters in the 2276 federation, only the cluster that received the request. 2277 You must be an administrator to use this flag. Default `False`. 2278 2279 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2280 2281 * count: str --- A string to determine result counting behavior. Supported values are: 2282 2283 * `"exact"`: The response will include an `items_available` field that 2284 counts the number of objects that matched this search criteria, 2285 including ones not included in `items`. 2286 2287 * `"none"`: The response will not include an `items_avaliable` 2288 field. This improves performance by returning a result as soon as enough 2289 `items` have been loaded for this result. 2290 2291 Default `'exact'`. 2292 2293 * distinct: bool --- If this is true, and multiple objects have the same values 2294 for the attributes that you specify in the `select` parameter, then each unique 2295 set of values will only be returned once in the result set. Default `False`. 2296 2297 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2298 Refer to the [filters reference][] for more information about how to write filters. 2299 2300 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2301 2302 * limit: int --- The maximum number of objects to return in the result. 2303 Note that the API may return fewer results than this if your request hits other 2304 limits set by the administrator. Default `100`. 2305 2306 * offset: int --- Return matching objects starting from this index. 2307 Note that result indexes may change if objects are modified in between a series 2308 of list calls. Default `0`. 2309 2310 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2311 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2312 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2313 2314 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2315 2316 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2317 The keys of this object are attribute names. 2318 Each value is either a single matching value or an array of matching values for that attribute. 2319 The `filters` parameter is more flexible and preferred. 2320 """
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]:
2322 def update(self, *, body: "Dict[Literal['log'], Log]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Log]': 2323 """Update attributes of an existing Log. 2324 2325 Required parameters: 2326 2327 * body: Dict[Literal['log'], Log] --- A dictionary with a single item `'log'`. 2328 Its value is a `Log` dictionary defining the attributes to set. 2329 2330 * uuid: str --- The UUID of the Log to update. 2331 2332 Optional parameters: 2333 2334 * select: Optional[List] --- An array of names of attributes to return in the response. 2335 """
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:
2338class Sys: 2339 """Methods to query and manipulate Arvados sys""" 2340 2341 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 2342 """Run scheduled data trash and sweep operations across this cluster's Keep services."""
Methods to query and manipulate Arvados sys
class
UserAgreement(typing.TypedDict):
2345class UserAgreement(TypedDict, total=False): 2346 """Arvados user agreement 2347 2348 A user agreement is a collection with terms that users must agree to before 2349 they can use this Arvados cluster. 2350 2351 This is the dictionary object that represents a single UserAgreement in Arvados 2352 and is returned by most `UserAgreements` methods. 2353 The keys of the dictionary are documented below, along with their types. 2354 Not every key may appear in every dictionary returned by an API call. 2355 When a method doesn't return all the data, you can use its `select` parameter 2356 to list the specific keys you need. Refer to the API documentation for details. 2357 """ 2358 etag: 'str' 2359 """Object cache version.""" 2360 owner_uuid: 'str' 2361 """The UUID of the user or group that owns this user agreement.""" 2362 created_at: 'str' 2363 """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`.""" 2364 modified_by_user_uuid: 'str' 2365 """The UUID of the user that last updated this user agreement.""" 2366 modified_at: 'str' 2367 """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`.""" 2368 portable_data_hash: 'str' 2369 """The portable data hash of this user agreement. This string provides a unique 2370 and stable reference to these contents. 2371 """ 2372 replication_desired: 'int' 2373 """The number of copies that should be made for data in this user agreement.""" 2374 replication_confirmed_at: 'str' 2375 """The last time the cluster confirmed that it met `replication_confirmed` 2376 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`. 2377 """ 2378 replication_confirmed: 'int' 2379 """The number of copies of data in this user agreement that the cluster has confirmed 2380 exist in storage. 2381 """ 2382 uuid: 'str' 2383 """This user agreement's Arvados UUID, like `zzzzz-gv0sa-12345abcde67890`.""" 2384 manifest_text: 'str' 2385 """The manifest text that describes how files are constructed from data blocks 2386 in this user agreement. Refer to the [manifest format][] reference for details. 2387 2388 [manifest format]: https://doc.arvados.org/architecture/manifest-format.html 2389 """ 2390 name: 'str' 2391 """The name of this user agreement assigned by a user.""" 2392 description: 'str' 2393 """A longer HTML description of this user agreement assigned by a user. 2394 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 2395 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 2396 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 2397 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 2398 """ 2399 properties: 'Dict[str, Any]' 2400 """A hash of arbitrary metadata for this user agreement. 2401 Some keys may be reserved by Arvados or defined by a configured vocabulary. 2402 Refer to the [metadata properties reference][] for details. 2403 2404 [metadata properties reference]: https://doc.arvados.org/api/properties.html 2405 """ 2406 delete_at: 'str' 2407 """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`.""" 2408 trash_at: 'str' 2409 """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`.""" 2410 is_trashed: 'bool' 2411 """A boolean flag to indicate whether or not this user agreement is trashed.""" 2412 storage_classes_desired: 'List' 2413 """An array of strings identifying the storage class(es) that should be used 2414 for data in this user agreement. Storage classes are configured by the cluster administrator. 2415 """ 2416 storage_classes_confirmed: 'List' 2417 """An array of strings identifying the storage class(es) the cluster has 2418 confirmed have a copy of this user agreement's data. 2419 """ 2420 storage_classes_confirmed_at: 'str' 2421 """The last time the cluster confirmed that data was stored on the storage 2422 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`. 2423 """ 2424 current_version_uuid: 'str' 2425 """The UUID of the current version of this user agreement.""" 2426 version: 'int' 2427 """An integer that counts which version of a user agreement this record 2428 represents. Refer to [collection versioning][] for details. This attribute is 2429 read-only. 2430 2431 [collection versioning]: https://doc.arvados.org/user/topics/collection-versioning.html 2432 """ 2433 preserve_version: 'bool' 2434 """A boolean flag to indicate whether this specific version of this user agreement 2435 should be persisted in cluster storage. 2436 """ 2437 file_count: 'int' 2438 """The number of files represented in this user agreement's `manifest_text`. 2439 This attribute is read-only. 2440 """ 2441 file_size_total: 'int' 2442 """The total size in bytes of files represented in this user agreement's `manifest_text`. 2443 This attribute is read-only. 2444 """
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):
2447class UserAgreementList(TypedDict, total=False): 2448 """A list of UserAgreement objects. 2449 2450 This is the dictionary object returned when you call `UserAgreements.list`. 2451 If you just want to iterate all objects that match your search criteria, 2452 consider using `arvados.util.keyset_list_all`. 2453 If you work with this raw object, the keys of the dictionary are documented 2454 below, along with their types. The `items` key maps to a list of matching 2455 `UserAgreement` objects. 2456 """ 2457 kind: 'str' = 'arvados#userAgreementList' 2458 """Object type. Always arvados#userAgreementList.""" 2459 etag: 'str' 2460 """List cache version.""" 2461 items: 'List[UserAgreement]' 2462 """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:
2465class UserAgreements: 2466 """Methods to query and manipulate Arvados user agreements""" 2467 2468 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]': 2469 """Create a new UserAgreement. 2470 2471 Required parameters: 2472 2473 * body: Dict[Literal['user_agreement'], UserAgreement] --- A dictionary with a single item `'user_agreement'`. 2474 Its value is a `UserAgreement` dictionary defining the attributes to set. 2475 2476 Optional parameters: 2477 2478 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2479 2480 * 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`. 2481 2482 * select: Optional[List] --- An array of names of attributes to return in the response. 2483 """ 2484 2485 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[UserAgreement]': 2486 """Delete an existing UserAgreement. 2487 2488 Required parameters: 2489 2490 * uuid: str --- The UUID of the UserAgreement to delete. 2491 """ 2492 2493 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2494 """Get a UserAgreement record by UUID. 2495 2496 Required parameters: 2497 2498 * uuid: str --- The UUID of the UserAgreement to return. 2499 2500 Optional parameters: 2501 2502 * select: Optional[List] --- An array of names of attributes to return in the response. 2503 """ 2504 2505 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]': 2506 """Retrieve a UserAgreementList. 2507 2508 This method returns a single page of `UserAgreement` objects that match your search 2509 criteria. If you just want to iterate all objects that match your search 2510 criteria, consider using `arvados.util.keyset_list_all`. 2511 2512 Optional parameters: 2513 2514 * bypass_federation: bool --- If true, do not return results from other clusters in the 2515 federation, only the cluster that received the request. 2516 You must be an administrator to use this flag. Default `False`. 2517 2518 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2519 2520 * count: str --- A string to determine result counting behavior. Supported values are: 2521 2522 * `"exact"`: The response will include an `items_available` field that 2523 counts the number of objects that matched this search criteria, 2524 including ones not included in `items`. 2525 2526 * `"none"`: The response will not include an `items_avaliable` 2527 field. This improves performance by returning a result as soon as enough 2528 `items` have been loaded for this result. 2529 2530 Default `'exact'`. 2531 2532 * distinct: bool --- If this is true, and multiple objects have the same values 2533 for the attributes that you specify in the `select` parameter, then each unique 2534 set of values will only be returned once in the result set. Default `False`. 2535 2536 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2537 Refer to the [filters reference][] for more information about how to write filters. 2538 2539 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2540 2541 * limit: int --- The maximum number of objects to return in the result. 2542 Note that the API may return fewer results than this if your request hits other 2543 limits set by the administrator. Default `100`. 2544 2545 * offset: int --- Return matching objects starting from this index. 2546 Note that result indexes may change if objects are modified in between a series 2547 of list calls. Default `0`. 2548 2549 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2550 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2551 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2552 2553 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2554 2555 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2556 The keys of this object are attribute names. 2557 Each value is either a single matching value or an array of matching values for that attribute. 2558 The `filters` parameter is more flexible and preferred. 2559 """ 2560 2561 def sign(self) -> 'ArvadosAPIRequest[UserAgreement]': 2562 """Create a signature link from the current user for a given user agreement.""" 2563 2564 def signatures(self) -> 'ArvadosAPIRequest[UserAgreement]': 2565 """List all user agreement signature links from a user.""" 2566 2567 def update(self, *, body: "Dict[Literal['user_agreement'], UserAgreement]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2568 """Update attributes of an existing UserAgreement. 2569 2570 Required parameters: 2571 2572 * body: Dict[Literal['user_agreement'], UserAgreement] --- A dictionary with a single item `'user_agreement'`. 2573 Its value is a `UserAgreement` dictionary defining the attributes to set. 2574 2575 * uuid: str --- The UUID of the UserAgreement to update. 2576 2577 Optional parameters: 2578 2579 * select: Optional[List] --- An array of names of attributes to return in the response. 2580 """
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]:
2468 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]': 2469 """Create a new UserAgreement. 2470 2471 Required parameters: 2472 2473 * body: Dict[Literal['user_agreement'], UserAgreement] --- A dictionary with a single item `'user_agreement'`. 2474 Its value is a `UserAgreement` dictionary defining the attributes to set. 2475 2476 Optional parameters: 2477 2478 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2479 2480 * 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`. 2481 2482 * select: Optional[List] --- An array of names of attributes to return in the response. 2483 """
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.
2485 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[UserAgreement]': 2486 """Delete an existing UserAgreement. 2487 2488 Required parameters: 2489 2490 * uuid: str --- The UUID of the UserAgreement to delete. 2491 """
Delete an existing UserAgreement.
Required parameters:
- uuid: str — The UUID of the UserAgreement to delete.
2493 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2494 """Get a UserAgreement record by UUID. 2495 2496 Required parameters: 2497 2498 * uuid: str --- The UUID of the UserAgreement to return. 2499 2500 Optional parameters: 2501 2502 * select: Optional[List] --- An array of names of attributes to return in the response. 2503 """
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]:
2505 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]': 2506 """Retrieve a UserAgreementList. 2507 2508 This method returns a single page of `UserAgreement` objects that match your search 2509 criteria. If you just want to iterate all objects that match your search 2510 criteria, consider using `arvados.util.keyset_list_all`. 2511 2512 Optional parameters: 2513 2514 * bypass_federation: bool --- If true, do not return results from other clusters in the 2515 federation, only the cluster that received the request. 2516 You must be an administrator to use this flag. Default `False`. 2517 2518 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2519 2520 * count: str --- A string to determine result counting behavior. Supported values are: 2521 2522 * `"exact"`: The response will include an `items_available` field that 2523 counts the number of objects that matched this search criteria, 2524 including ones not included in `items`. 2525 2526 * `"none"`: The response will not include an `items_avaliable` 2527 field. This improves performance by returning a result as soon as enough 2528 `items` have been loaded for this result. 2529 2530 Default `'exact'`. 2531 2532 * distinct: bool --- If this is true, and multiple objects have the same values 2533 for the attributes that you specify in the `select` parameter, then each unique 2534 set of values will only be returned once in the result set. Default `False`. 2535 2536 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2537 Refer to the [filters reference][] for more information about how to write filters. 2538 2539 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2540 2541 * limit: int --- The maximum number of objects to return in the result. 2542 Note that the API may return fewer results than this if your request hits other 2543 limits set by the administrator. Default `100`. 2544 2545 * offset: int --- Return matching objects starting from this index. 2546 Note that result indexes may change if objects are modified in between a series 2547 of list calls. Default `0`. 2548 2549 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2550 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2551 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2552 2553 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2554 2555 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2556 The keys of this object are attribute names. 2557 Each value is either a single matching value or an array of matching values for that attribute. 2558 The `filters` parameter is more flexible and preferred. 2559 """
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.
2561 def sign(self) -> 'ArvadosAPIRequest[UserAgreement]': 2562 """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.
2564 def signatures(self) -> 'ArvadosAPIRequest[UserAgreement]': 2565 """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]:
2567 def update(self, *, body: "Dict[Literal['user_agreement'], UserAgreement]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[UserAgreement]': 2568 """Update attributes of an existing UserAgreement. 2569 2570 Required parameters: 2571 2572 * body: Dict[Literal['user_agreement'], UserAgreement] --- A dictionary with a single item `'user_agreement'`. 2573 Its value is a `UserAgreement` dictionary defining the attributes to set. 2574 2575 * uuid: str --- The UUID of the UserAgreement to update. 2576 2577 Optional parameters: 2578 2579 * select: Optional[List] --- An array of names of attributes to return in the response. 2580 """
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):
2583class User(TypedDict, total=False): 2584 """Arvados user 2585 2586 A user represents a single individual or role who may be authorized to access 2587 this Arvados cluster. 2588 2589 This is the dictionary object that represents a single User in Arvados 2590 and is returned by most `Users` methods. 2591 The keys of the dictionary are documented below, along with their types. 2592 Not every key may appear in every dictionary returned by an API call. 2593 When a method doesn't return all the data, you can use its `select` parameter 2594 to list the specific keys you need. Refer to the API documentation for details. 2595 """ 2596 etag: 'str' 2597 """Object cache version.""" 2598 uuid: 'str' 2599 """This user's Arvados UUID, like `zzzzz-tpzed-12345abcde67890`.""" 2600 owner_uuid: 'str' 2601 """The UUID of the user or group that owns this user.""" 2602 created_at: 'str' 2603 """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`.""" 2604 modified_by_user_uuid: 'str' 2605 """The UUID of the user that last updated this user.""" 2606 modified_at: 'str' 2607 """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`.""" 2608 email: 'str' 2609 """This user's email address.""" 2610 first_name: 'str' 2611 """This user's first name.""" 2612 last_name: 'str' 2613 """This user's last name.""" 2614 identity_url: 'str' 2615 """A URL that represents this user with the cluster's identity provider.""" 2616 is_admin: 'bool' 2617 """A boolean flag. If set, this user is an administrator of the Arvados 2618 cluster, and automatically passes most permissions checks. 2619 """ 2620 prefs: 'Dict[str, Any]' 2621 """A hash that stores cluster-wide user preferences.""" 2622 is_active: 'bool' 2623 """A boolean flag. If unset, this user is not permitted to make any Arvados 2624 API requests. 2625 """ 2626 username: 'str' 2627 """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):
2630class UserList(TypedDict, total=False): 2631 """A list of User objects. 2632 2633 This is the dictionary object returned when you call `Users.list`. 2634 If you just want to iterate all objects that match your search criteria, 2635 consider using `arvados.util.keyset_list_all`. 2636 If you work with this raw object, the keys of the dictionary are documented 2637 below, along with their types. The `items` key maps to a list of matching 2638 `User` objects. 2639 """ 2640 kind: 'str' = 'arvados#userList' 2641 """Object type. Always arvados#userList.""" 2642 etag: 'str' 2643 """List cache version.""" 2644 items: 'List[User]' 2645 """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:
2648class Users: 2649 """Methods to query and manipulate Arvados users""" 2650 2651 def activate(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2652 """Set the `is_active` flag on a user record. 2653 2654 Required parameters: 2655 2656 * uuid: str --- The UUID of the User to update. 2657 """ 2658 2659 def create(self, *, body: "Dict[Literal['user'], User]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2660 """Create a new User. 2661 2662 Required parameters: 2663 2664 * body: Dict[Literal['user'], User] --- A dictionary with a single item `'user'`. 2665 Its value is a `User` dictionary defining the attributes to set. 2666 2667 Optional parameters: 2668 2669 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2670 2671 * 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`. 2672 2673 * select: Optional[List] --- An array of names of attributes to return in the response. 2674 """ 2675 2676 def current(self) -> 'ArvadosAPIRequest[User]': 2677 """Return the user record associated with the API token authorizing this request.""" 2678 2679 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2680 """Delete an existing User. 2681 2682 Required parameters: 2683 2684 * uuid: str --- The UUID of the User to delete. 2685 """ 2686 2687 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2688 """Get a User record by UUID. 2689 2690 Required parameters: 2691 2692 * uuid: str --- The UUID of the User to return. 2693 2694 Optional parameters: 2695 2696 * select: Optional[List] --- An array of names of attributes to return in the response. 2697 """ 2698 2699 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]': 2700 """Retrieve a UserList. 2701 2702 This method returns a single page of `User` objects that match your search 2703 criteria. If you just want to iterate all objects that match your search 2704 criteria, consider using `arvados.util.keyset_list_all`. 2705 2706 Optional parameters: 2707 2708 * bypass_federation: bool --- If true, do not return results from other clusters in the 2709 federation, only the cluster that received the request. 2710 You must be an administrator to use this flag. Default `False`. 2711 2712 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2713 2714 * count: str --- A string to determine result counting behavior. Supported values are: 2715 2716 * `"exact"`: The response will include an `items_available` field that 2717 counts the number of objects that matched this search criteria, 2718 including ones not included in `items`. 2719 2720 * `"none"`: The response will not include an `items_avaliable` 2721 field. This improves performance by returning a result as soon as enough 2722 `items` have been loaded for this result. 2723 2724 Default `'exact'`. 2725 2726 * distinct: bool --- If this is true, and multiple objects have the same values 2727 for the attributes that you specify in the `select` parameter, then each unique 2728 set of values will only be returned once in the result set. Default `False`. 2729 2730 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2731 Refer to the [filters reference][] for more information about how to write filters. 2732 2733 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2734 2735 * limit: int --- The maximum number of objects to return in the result. 2736 Note that the API may return fewer results than this if your request hits other 2737 limits set by the administrator. Default `100`. 2738 2739 * offset: int --- Return matching objects starting from this index. 2740 Note that result indexes may change if objects are modified in between a series 2741 of list calls. Default `0`. 2742 2743 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2744 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2745 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2746 2747 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2748 2749 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2750 The keys of this object are attribute names. 2751 Each value is either a single matching value or an array of matching values for that attribute. 2752 The `filters` parameter is more flexible and preferred. 2753 """ 2754 2755 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]': 2756 """Transfer ownership of one user's data to another. 2757 2758 Required parameters: 2759 2760 * new_owner_uuid: str --- UUID of the user or group that will take ownership of data owned by the old user. 2761 2762 Optional parameters: 2763 2764 * 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. 2765 2766 * new_user_uuid: Optional[str] --- UUID of the user receiving ownership. You must be an admin to use this option. 2767 2768 * 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. 2769 2770 * redirect_to_new_user: bool --- If true, authorization attempts for the old user will be redirected to the new user. Default `False`. 2771 """ 2772 2773 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]': 2774 """Convenience method to "fully" set up a user record with a virtual machine login and notification email. 2775 2776 Optional parameters: 2777 2778 * repo_name: Optional[str] --- This parameter is obsolete and ignored. 2779 2780 * send_notification_email: bool --- If true, send an email to the user notifying them they can now access this Arvados cluster. Default `False`. 2781 2782 * user: Optional[Dict[str, Any]] --- Attributes of a new user record to set up. 2783 2784 * uuid: Optional[str] --- UUID of an existing user record to set up. 2785 2786 * vm_uuid: Optional[str] --- If given, setup creates a login link to allow this user to access the Arvados virtual machine with this UUID. 2787 """ 2788 2789 def system(self) -> 'ArvadosAPIRequest[User]': 2790 """Return this cluster's system ("root") user record.""" 2791 2792 def unsetup(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2793 """Unset a user's active flag and delete associated records. 2794 2795 Required parameters: 2796 2797 * uuid: str --- The UUID of the User to update. 2798 """ 2799 2800 def update(self, *, body: "Dict[Literal['user'], User]", uuid: 'str', bypass_federation: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2801 """Update attributes of an existing User. 2802 2803 Required parameters: 2804 2805 * body: Dict[Literal['user'], User] --- A dictionary with a single item `'user'`. 2806 Its value is a `User` dictionary defining the attributes to set. 2807 2808 * uuid: str --- The UUID of the User to update. 2809 2810 Optional parameters: 2811 2812 * bypass_federation: bool --- If true, do not try to update the user on any other clusters in the federation, 2813 only the cluster that received the request. 2814 You must be an administrator to use this flag. Default `False`. 2815 2816 * select: Optional[List] --- An array of names of attributes to return in the response. 2817 """
Methods to query and manipulate Arvados users
2651 def activate(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2652 """Set the `is_active` flag on a user record. 2653 2654 Required parameters: 2655 2656 * uuid: str --- The UUID of the User to update. 2657 """
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]:
2659 def create(self, *, body: "Dict[Literal['user'], User]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2660 """Create a new User. 2661 2662 Required parameters: 2663 2664 * body: Dict[Literal['user'], User] --- A dictionary with a single item `'user'`. 2665 Its value is a `User` dictionary defining the attributes to set. 2666 2667 Optional parameters: 2668 2669 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2670 2671 * 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`. 2672 2673 * select: Optional[List] --- An array of names of attributes to return in the response. 2674 """
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.
2676 def current(self) -> 'ArvadosAPIRequest[User]': 2677 """Return the user record associated with the API token authorizing this request."""
Return the user record associated with the API token authorizing this request.
2679 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2680 """Delete an existing User. 2681 2682 Required parameters: 2683 2684 * uuid: str --- The UUID of the User to delete. 2685 """
Delete an existing User.
Required parameters:
- uuid: str — The UUID of the User to delete.
2687 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2688 """Get a User record by UUID. 2689 2690 Required parameters: 2691 2692 * uuid: str --- The UUID of the User to return. 2693 2694 Optional parameters: 2695 2696 * select: Optional[List] --- An array of names of attributes to return in the response. 2697 """
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]:
2699 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]': 2700 """Retrieve a UserList. 2701 2702 This method returns a single page of `User` objects that match your search 2703 criteria. If you just want to iterate all objects that match your search 2704 criteria, consider using `arvados.util.keyset_list_all`. 2705 2706 Optional parameters: 2707 2708 * bypass_federation: bool --- If true, do not return results from other clusters in the 2709 federation, only the cluster that received the request. 2710 You must be an administrator to use this flag. Default `False`. 2711 2712 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2713 2714 * count: str --- A string to determine result counting behavior. Supported values are: 2715 2716 * `"exact"`: The response will include an `items_available` field that 2717 counts the number of objects that matched this search criteria, 2718 including ones not included in `items`. 2719 2720 * `"none"`: The response will not include an `items_avaliable` 2721 field. This improves performance by returning a result as soon as enough 2722 `items` have been loaded for this result. 2723 2724 Default `'exact'`. 2725 2726 * distinct: bool --- If this is true, and multiple objects have the same values 2727 for the attributes that you specify in the `select` parameter, then each unique 2728 set of values will only be returned once in the result set. Default `False`. 2729 2730 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2731 Refer to the [filters reference][] for more information about how to write filters. 2732 2733 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2734 2735 * limit: int --- The maximum number of objects to return in the result. 2736 Note that the API may return fewer results than this if your request hits other 2737 limits set by the administrator. Default `100`. 2738 2739 * offset: int --- Return matching objects starting from this index. 2740 Note that result indexes may change if objects are modified in between a series 2741 of list calls. Default `0`. 2742 2743 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2744 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2745 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2746 2747 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2748 2749 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2750 The keys of this object are attribute names. 2751 Each value is either a single matching value or an array of matching values for that attribute. 2752 The `filters` parameter is more flexible and preferred. 2753 """
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]:
2755 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]': 2756 """Transfer ownership of one user's data to another. 2757 2758 Required parameters: 2759 2760 * new_owner_uuid: str --- UUID of the user or group that will take ownership of data owned by the old user. 2761 2762 Optional parameters: 2763 2764 * 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. 2765 2766 * new_user_uuid: Optional[str] --- UUID of the user receiving ownership. You must be an admin to use this option. 2767 2768 * 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. 2769 2770 * redirect_to_new_user: bool --- If true, authorization attempts for the old user will be redirected to the new user. Default `False`. 2771 """
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]:
2773 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]': 2774 """Convenience method to "fully" set up a user record with a virtual machine login and notification email. 2775 2776 Optional parameters: 2777 2778 * repo_name: Optional[str] --- This parameter is obsolete and ignored. 2779 2780 * send_notification_email: bool --- If true, send an email to the user notifying them they can now access this Arvados cluster. Default `False`. 2781 2782 * user: Optional[Dict[str, Any]] --- Attributes of a new user record to set up. 2783 2784 * uuid: Optional[str] --- UUID of an existing user record to set up. 2785 2786 * vm_uuid: Optional[str] --- If given, setup creates a login link to allow this user to access the Arvados virtual machine with this UUID. 2787 """
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.
2789 def system(self) -> 'ArvadosAPIRequest[User]': 2790 """Return this cluster's system ("root") user record."""
Return this cluster’s system ("root") user record.
2792 def unsetup(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]': 2793 """Unset a user's active flag and delete associated records. 2794 2795 Required parameters: 2796 2797 * uuid: str --- The UUID of the User to update. 2798 """
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]:
2800 def update(self, *, body: "Dict[Literal['user'], User]", uuid: 'str', bypass_federation: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[User]': 2801 """Update attributes of an existing User. 2802 2803 Required parameters: 2804 2805 * body: Dict[Literal['user'], User] --- A dictionary with a single item `'user'`. 2806 Its value is a `User` dictionary defining the attributes to set. 2807 2808 * uuid: str --- The UUID of the User to update. 2809 2810 Optional parameters: 2811 2812 * bypass_federation: bool --- If true, do not try to update the user on any other clusters in the federation, 2813 only the cluster that received the request. 2814 You must be an administrator to use this flag. Default `False`. 2815 2816 * select: Optional[List] --- An array of names of attributes to return in the response. 2817 """
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):
2820class VirtualMachine(TypedDict, total=False): 2821 """Arvados virtual machine ("shell node") 2822 2823 This resource stores information about a virtual machine or "shell node" 2824 hosted on this Arvados cluster where users can log in and use preconfigured 2825 Arvados client tools. 2826 2827 This is the dictionary object that represents a single VirtualMachine in Arvados 2828 and is returned by most `VirtualMachines` methods. 2829 The keys of the dictionary are documented below, along with their types. 2830 Not every key may appear in every dictionary returned by an API call. 2831 When a method doesn't return all the data, you can use its `select` parameter 2832 to list the specific keys you need. Refer to the API documentation for details. 2833 """ 2834 etag: 'str' 2835 """Object cache version.""" 2836 uuid: 'str' 2837 """This virtual machine's Arvados UUID, like `zzzzz-2x53u-12345abcde67890`.""" 2838 owner_uuid: 'str' 2839 """The UUID of the user or group that owns this virtual machine.""" 2840 modified_by_user_uuid: 'str' 2841 """The UUID of the user that last updated this virtual machine.""" 2842 modified_at: 'str' 2843 """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`.""" 2844 hostname: 'str' 2845 """The DNS hostname where users should access this virtual machine.""" 2846 created_at: 'str' 2847 """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):
2850class VirtualMachineList(TypedDict, total=False): 2851 """A list of VirtualMachine objects. 2852 2853 This is the dictionary object returned when you call `VirtualMachines.list`. 2854 If you just want to iterate all objects that match your search criteria, 2855 consider using `arvados.util.keyset_list_all`. 2856 If you work with this raw object, the keys of the dictionary are documented 2857 below, along with their types. The `items` key maps to a list of matching 2858 `VirtualMachine` objects. 2859 """ 2860 kind: 'str' = 'arvados#virtualMachineList' 2861 """Object type. Always arvados#virtualMachineList.""" 2862 etag: 'str' 2863 """List cache version.""" 2864 items: 'List[VirtualMachine]' 2865 """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:
2868class VirtualMachines: 2869 """Methods to query and manipulate Arvados virtual machines""" 2870 2871 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]': 2872 """Create a new VirtualMachine. 2873 2874 Required parameters: 2875 2876 * body: Dict[Literal['virtual_machine'], VirtualMachine] --- A dictionary with a single item `'virtual_machine'`. 2877 Its value is a `VirtualMachine` dictionary defining the attributes to set. 2878 2879 Optional parameters: 2880 2881 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2882 2883 * 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`. 2884 2885 * select: Optional[List] --- An array of names of attributes to return in the response. 2886 """ 2887 2888 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]': 2889 """Delete an existing VirtualMachine. 2890 2891 Required parameters: 2892 2893 * uuid: str --- The UUID of the VirtualMachine to delete. 2894 """ 2895 2896 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 2897 """Get a VirtualMachine record by UUID. 2898 2899 Required parameters: 2900 2901 * uuid: str --- The UUID of the VirtualMachine to return. 2902 2903 Optional parameters: 2904 2905 * select: Optional[List] --- An array of names of attributes to return in the response. 2906 """ 2907 2908 def get_all_logins(self) -> 'ArvadosAPIRequest[VirtualMachine]': 2909 """List login permission links for all virtual machines.""" 2910 2911 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]': 2912 """Retrieve a VirtualMachineList. 2913 2914 This method returns a single page of `VirtualMachine` objects that match your search 2915 criteria. If you just want to iterate all objects that match your search 2916 criteria, consider using `arvados.util.keyset_list_all`. 2917 2918 Optional parameters: 2919 2920 * bypass_federation: bool --- If true, do not return results from other clusters in the 2921 federation, only the cluster that received the request. 2922 You must be an administrator to use this flag. Default `False`. 2923 2924 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2925 2926 * count: str --- A string to determine result counting behavior. Supported values are: 2927 2928 * `"exact"`: The response will include an `items_available` field that 2929 counts the number of objects that matched this search criteria, 2930 including ones not included in `items`. 2931 2932 * `"none"`: The response will not include an `items_avaliable` 2933 field. This improves performance by returning a result as soon as enough 2934 `items` have been loaded for this result. 2935 2936 Default `'exact'`. 2937 2938 * distinct: bool --- If this is true, and multiple objects have the same values 2939 for the attributes that you specify in the `select` parameter, then each unique 2940 set of values will only be returned once in the result set. Default `False`. 2941 2942 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2943 Refer to the [filters reference][] for more information about how to write filters. 2944 2945 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2946 2947 * limit: int --- The maximum number of objects to return in the result. 2948 Note that the API may return fewer results than this if your request hits other 2949 limits set by the administrator. Default `100`. 2950 2951 * offset: int --- Return matching objects starting from this index. 2952 Note that result indexes may change if objects are modified in between a series 2953 of list calls. Default `0`. 2954 2955 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2956 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2957 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2958 2959 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2960 2961 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2962 The keys of this object are attribute names. 2963 Each value is either a single matching value or an array of matching values for that attribute. 2964 The `filters` parameter is more flexible and preferred. 2965 """ 2966 2967 def logins(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]': 2968 """List login permission links for a given virtual machine. 2969 2970 Required parameters: 2971 2972 * uuid: str --- The UUID of the VirtualMachine to query. 2973 """ 2974 2975 def update(self, *, body: "Dict[Literal['virtual_machine'], VirtualMachine]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 2976 """Update attributes of an existing VirtualMachine. 2977 2978 Required parameters: 2979 2980 * body: Dict[Literal['virtual_machine'], VirtualMachine] --- A dictionary with a single item `'virtual_machine'`. 2981 Its value is a `VirtualMachine` dictionary defining the attributes to set. 2982 2983 * uuid: str --- The UUID of the VirtualMachine to update. 2984 2985 Optional parameters: 2986 2987 * select: Optional[List] --- An array of names of attributes to return in the response. 2988 """
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]:
2871 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]': 2872 """Create a new VirtualMachine. 2873 2874 Required parameters: 2875 2876 * body: Dict[Literal['virtual_machine'], VirtualMachine] --- A dictionary with a single item `'virtual_machine'`. 2877 Its value is a `VirtualMachine` dictionary defining the attributes to set. 2878 2879 Optional parameters: 2880 2881 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 2882 2883 * 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`. 2884 2885 * select: Optional[List] --- An array of names of attributes to return in the response. 2886 """
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.
2888 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]': 2889 """Delete an existing VirtualMachine. 2890 2891 Required parameters: 2892 2893 * uuid: str --- The UUID of the VirtualMachine to delete. 2894 """
Delete an existing VirtualMachine.
Required parameters:
- uuid: str — The UUID of the VirtualMachine to delete.
2896 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 2897 """Get a VirtualMachine record by UUID. 2898 2899 Required parameters: 2900 2901 * uuid: str --- The UUID of the VirtualMachine to return. 2902 2903 Optional parameters: 2904 2905 * select: Optional[List] --- An array of names of attributes to return in the response. 2906 """
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.
2908 def get_all_logins(self) -> 'ArvadosAPIRequest[VirtualMachine]': 2909 """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]:
2911 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]': 2912 """Retrieve a VirtualMachineList. 2913 2914 This method returns a single page of `VirtualMachine` objects that match your search 2915 criteria. If you just want to iterate all objects that match your search 2916 criteria, consider using `arvados.util.keyset_list_all`. 2917 2918 Optional parameters: 2919 2920 * bypass_federation: bool --- If true, do not return results from other clusters in the 2921 federation, only the cluster that received the request. 2922 You must be an administrator to use this flag. Default `False`. 2923 2924 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 2925 2926 * count: str --- A string to determine result counting behavior. Supported values are: 2927 2928 * `"exact"`: The response will include an `items_available` field that 2929 counts the number of objects that matched this search criteria, 2930 including ones not included in `items`. 2931 2932 * `"none"`: The response will not include an `items_avaliable` 2933 field. This improves performance by returning a result as soon as enough 2934 `items` have been loaded for this result. 2935 2936 Default `'exact'`. 2937 2938 * distinct: bool --- If this is true, and multiple objects have the same values 2939 for the attributes that you specify in the `select` parameter, then each unique 2940 set of values will only be returned once in the result set. Default `False`. 2941 2942 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 2943 Refer to the [filters reference][] for more information about how to write filters. 2944 2945 [filters reference]: https://doc.arvados.org/api/methods.html#filters 2946 2947 * limit: int --- The maximum number of objects to return in the result. 2948 Note that the API may return fewer results than this if your request hits other 2949 limits set by the administrator. Default `100`. 2950 2951 * offset: int --- Return matching objects starting from this index. 2952 Note that result indexes may change if objects are modified in between a series 2953 of list calls. Default `0`. 2954 2955 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 2956 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 2957 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 2958 2959 * select: Optional[List] --- An array of names of attributes to return from each matching object. 2960 2961 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 2962 The keys of this object are attribute names. 2963 Each value is either a single matching value or an array of matching values for that attribute. 2964 The `filters` parameter is more flexible and preferred. 2965 """
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.
2967 def logins(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]': 2968 """List login permission links for a given virtual machine. 2969 2970 Required parameters: 2971 2972 * uuid: str --- The UUID of the VirtualMachine to query. 2973 """
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]:
2975 def update(self, *, body: "Dict[Literal['virtual_machine'], VirtualMachine]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[VirtualMachine]': 2976 """Update attributes of an existing VirtualMachine. 2977 2978 Required parameters: 2979 2980 * body: Dict[Literal['virtual_machine'], VirtualMachine] --- A dictionary with a single item `'virtual_machine'`. 2981 Its value is a `VirtualMachine` dictionary defining the attributes to set. 2982 2983 * uuid: str --- The UUID of the VirtualMachine to update. 2984 2985 Optional parameters: 2986 2987 * select: Optional[List] --- An array of names of attributes to return in the response. 2988 """
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:
2991class Vocabularies: 2992 """Methods to query and manipulate Arvados vocabularies""" 2993 2994 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 2995 """Get this cluster's configured vocabulary definition. 2996 2997 Refer to [metadata vocabulary documentation][] for details. 2998 2999 [metadata vocabulary documentation]: https://doc.aravdos.org/admin/metadata-vocabulary.html 3000 """
Methods to query and manipulate Arvados vocabularies
2994 def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]': 2995 """Get this cluster's configured vocabulary definition. 2996 2997 Refer to [metadata vocabulary documentation][] for details. 2998 2999 [metadata vocabulary documentation]: https://doc.aravdos.org/admin/metadata-vocabulary.html 3000 """
Get this cluster’s configured vocabulary definition.
Refer to metadata vocabulary documentation for details.
class
Workflow(typing.TypedDict):
3003class Workflow(TypedDict, total=False): 3004 """Arvados workflow 3005 3006 A workflow contains workflow definition source code that Arvados can execute 3007 along with associated metadata for users. 3008 3009 This is the dictionary object that represents a single Workflow in Arvados 3010 and is returned by most `Workflows` methods. 3011 The keys of the dictionary are documented below, along with their types. 3012 Not every key may appear in every dictionary returned by an API call. 3013 When a method doesn't return all the data, you can use its `select` parameter 3014 to list the specific keys you need. Refer to the API documentation for details. 3015 """ 3016 etag: 'str' 3017 """Object cache version.""" 3018 uuid: 'str' 3019 """This workflow's Arvados UUID, like `zzzzz-7fd4e-12345abcde67890`.""" 3020 owner_uuid: 'str' 3021 """The UUID of the user or group that owns this workflow.""" 3022 created_at: 'str' 3023 """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`.""" 3024 modified_at: 'str' 3025 """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`.""" 3026 modified_by_user_uuid: 'str' 3027 """The UUID of the user that last updated this workflow.""" 3028 name: 'str' 3029 """The name of this workflow assigned by a user.""" 3030 description: 'str' 3031 """A longer HTML description of this workflow assigned by a user. 3032 Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, 3033 `del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, 3034 `i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, 3035 `s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`. 3036 """ 3037 definition: 'str' 3038 """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):
3041class WorkflowList(TypedDict, total=False): 3042 """A list of Workflow objects. 3043 3044 This is the dictionary object returned when you call `Workflows.list`. 3045 If you just want to iterate all objects that match your search criteria, 3046 consider using `arvados.util.keyset_list_all`. 3047 If you work with this raw object, the keys of the dictionary are documented 3048 below, along with their types. The `items` key maps to a list of matching 3049 `Workflow` objects. 3050 """ 3051 kind: 'str' = 'arvados#workflowList' 3052 """Object type. Always arvados#workflowList.""" 3053 etag: 'str' 3054 """List cache version.""" 3055 items: 'List[Workflow]' 3056 """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:
3059class Workflows: 3060 """Methods to query and manipulate Arvados workflows""" 3061 3062 def create(self, *, body: "Dict[Literal['workflow'], Workflow]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3063 """Create a new Workflow. 3064 3065 Required parameters: 3066 3067 * body: Dict[Literal['workflow'], Workflow] --- A dictionary with a single item `'workflow'`. 3068 Its value is a `Workflow` dictionary defining the attributes to set. 3069 3070 Optional parameters: 3071 3072 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 3073 3074 * 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`. 3075 3076 * select: Optional[List] --- An array of names of attributes to return in the response. 3077 """ 3078 3079 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Workflow]': 3080 """Delete an existing Workflow. 3081 3082 Required parameters: 3083 3084 * uuid: str --- The UUID of the Workflow to delete. 3085 """ 3086 3087 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3088 """Get a Workflow record by UUID. 3089 3090 Required parameters: 3091 3092 * uuid: str --- The UUID of the Workflow to return. 3093 3094 Optional parameters: 3095 3096 * select: Optional[List] --- An array of names of attributes to return in the response. 3097 """ 3098 3099 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]': 3100 """Retrieve a WorkflowList. 3101 3102 This method returns a single page of `Workflow` objects that match your search 3103 criteria. If you just want to iterate all objects that match your search 3104 criteria, consider using `arvados.util.keyset_list_all`. 3105 3106 Optional parameters: 3107 3108 * bypass_federation: bool --- If true, do not return results from other clusters in the 3109 federation, only the cluster that received the request. 3110 You must be an administrator to use this flag. Default `False`. 3111 3112 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 3113 3114 * count: str --- A string to determine result counting behavior. Supported values are: 3115 3116 * `"exact"`: The response will include an `items_available` field that 3117 counts the number of objects that matched this search criteria, 3118 including ones not included in `items`. 3119 3120 * `"none"`: The response will not include an `items_avaliable` 3121 field. This improves performance by returning a result as soon as enough 3122 `items` have been loaded for this result. 3123 3124 Default `'exact'`. 3125 3126 * distinct: bool --- If this is true, and multiple objects have the same values 3127 for the attributes that you specify in the `select` parameter, then each unique 3128 set of values will only be returned once in the result set. Default `False`. 3129 3130 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 3131 Refer to the [filters reference][] for more information about how to write filters. 3132 3133 [filters reference]: https://doc.arvados.org/api/methods.html#filters 3134 3135 * limit: int --- The maximum number of objects to return in the result. 3136 Note that the API may return fewer results than this if your request hits other 3137 limits set by the administrator. Default `100`. 3138 3139 * offset: int --- Return matching objects starting from this index. 3140 Note that result indexes may change if objects are modified in between a series 3141 of list calls. Default `0`. 3142 3143 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 3144 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 3145 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 3146 3147 * select: Optional[List] --- An array of names of attributes to return from each matching object. 3148 3149 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 3150 The keys of this object are attribute names. 3151 Each value is either a single matching value or an array of matching values for that attribute. 3152 The `filters` parameter is more flexible and preferred. 3153 """ 3154 3155 def update(self, *, body: "Dict[Literal['workflow'], Workflow]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3156 """Update attributes of an existing Workflow. 3157 3158 Required parameters: 3159 3160 * body: Dict[Literal['workflow'], Workflow] --- A dictionary with a single item `'workflow'`. 3161 Its value is a `Workflow` dictionary defining the attributes to set. 3162 3163 * uuid: str --- The UUID of the Workflow to update. 3164 3165 Optional parameters: 3166 3167 * select: Optional[List] --- An array of names of attributes to return in the response. 3168 """
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]:
3062 def create(self, *, body: "Dict[Literal['workflow'], Workflow]", cluster_id: 'Optional[str]' = None, ensure_unique_name: 'bool' = False, select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3063 """Create a new Workflow. 3064 3065 Required parameters: 3066 3067 * body: Dict[Literal['workflow'], Workflow] --- A dictionary with a single item `'workflow'`. 3068 Its value is a `Workflow` dictionary defining the attributes to set. 3069 3070 Optional parameters: 3071 3072 * cluster_id: Optional[str] --- Cluster ID of a federated cluster where this object should be created. 3073 3074 * 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`. 3075 3076 * select: Optional[List] --- An array of names of attributes to return in the response. 3077 """
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.
3079 def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Workflow]': 3080 """Delete an existing Workflow. 3081 3082 Required parameters: 3083 3084 * uuid: str --- The UUID of the Workflow to delete. 3085 """
Delete an existing Workflow.
Required parameters:
- uuid: str — The UUID of the Workflow to delete.
3087 def get(self, *, uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3088 """Get a Workflow record by UUID. 3089 3090 Required parameters: 3091 3092 * uuid: str --- The UUID of the Workflow to return. 3093 3094 Optional parameters: 3095 3096 * select: Optional[List] --- An array of names of attributes to return in the response. 3097 """
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]:
3099 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]': 3100 """Retrieve a WorkflowList. 3101 3102 This method returns a single page of `Workflow` objects that match your search 3103 criteria. If you just want to iterate all objects that match your search 3104 criteria, consider using `arvados.util.keyset_list_all`. 3105 3106 Optional parameters: 3107 3108 * bypass_federation: bool --- If true, do not return results from other clusters in the 3109 federation, only the cluster that received the request. 3110 You must be an administrator to use this flag. Default `False`. 3111 3112 * cluster_id: Optional[str] --- Cluster ID of a federated cluster to return objects from 3113 3114 * count: str --- A string to determine result counting behavior. Supported values are: 3115 3116 * `"exact"`: The response will include an `items_available` field that 3117 counts the number of objects that matched this search criteria, 3118 including ones not included in `items`. 3119 3120 * `"none"`: The response will not include an `items_avaliable` 3121 field. This improves performance by returning a result as soon as enough 3122 `items` have been loaded for this result. 3123 3124 Default `'exact'`. 3125 3126 * distinct: bool --- If this is true, and multiple objects have the same values 3127 for the attributes that you specify in the `select` parameter, then each unique 3128 set of values will only be returned once in the result set. Default `False`. 3129 3130 * filters: Optional[List] --- Filters to limit which objects are returned by their attributes. 3131 Refer to the [filters reference][] for more information about how to write filters. 3132 3133 [filters reference]: https://doc.arvados.org/api/methods.html#filters 3134 3135 * limit: int --- The maximum number of objects to return in the result. 3136 Note that the API may return fewer results than this if your request hits other 3137 limits set by the administrator. Default `100`. 3138 3139 * offset: int --- Return matching objects starting from this index. 3140 Note that result indexes may change if objects are modified in between a series 3141 of list calls. Default `0`. 3142 3143 * order: Optional[List] --- An array of strings to set the order in which matching objects are returned. 3144 Each string has the format `<ATTRIBUTE> <DIRECTION>`. 3145 `DIRECTION` can be `asc` or omitted for ascending, or `desc` for descending. 3146 3147 * select: Optional[List] --- An array of names of attributes to return from each matching object. 3148 3149 * where: Optional[Dict[str, Any]] --- An object to limit which objects are returned by their attributes. 3150 The keys of this object are attribute names. 3151 Each value is either a single matching value or an array of matching values for that attribute. 3152 The `filters` parameter is more flexible and preferred. 3153 """
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]:
3155 def update(self, *, body: "Dict[Literal['workflow'], Workflow]", uuid: 'str', select: 'Optional[List]' = None) -> 'ArvadosAPIRequest[Workflow]': 3156 """Update attributes of an existing Workflow. 3157 3158 Required parameters: 3159 3160 * body: Dict[Literal['workflow'], Workflow] --- A dictionary with a single item `'workflow'`. 3161 Its value is a `Workflow` dictionary defining the attributes to set. 3162 3163 * uuid: str --- The UUID of the Workflow to update. 3164 3165 Optional parameters: 3166 3167 * select: Optional[List] --- An array of names of attributes to return in the response. 3168 """
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):
3171class ArvadosAPIClient(googleapiclient.discovery.Resource): 3172 3173 def api_client_authorizations(self) -> 'ApiClientAuthorizations': 3174 """Return an instance of `ApiClientAuthorizations` to call methods via this client""" 3175 3176 def authorized_keys(self) -> 'AuthorizedKeys': 3177 """Return an instance of `AuthorizedKeys` to call methods via this client""" 3178 3179 def collections(self) -> 'Collections': 3180 """Return an instance of `Collections` to call methods via this client""" 3181 3182 def computed_permissions(self) -> 'ComputedPermissions': 3183 """Return an instance of `ComputedPermissions` to call methods via this client""" 3184 3185 def configs(self) -> 'Configs': 3186 """Return an instance of `Configs` to call methods via this client""" 3187 3188 def container_requests(self) -> 'ContainerRequests': 3189 """Return an instance of `ContainerRequests` to call methods via this client""" 3190 3191 def containers(self) -> 'Containers': 3192 """Return an instance of `Containers` to call methods via this client""" 3193 3194 def groups(self) -> 'Groups': 3195 """Return an instance of `Groups` to call methods via this client""" 3196 3197 def keep_services(self) -> 'KeepServices': 3198 """Return an instance of `KeepServices` to call methods via this client""" 3199 3200 def links(self) -> 'Links': 3201 """Return an instance of `Links` to call methods via this client""" 3202 3203 def logs(self) -> 'Logs': 3204 """Return an instance of `Logs` to call methods via this client""" 3205 3206 def sys(self) -> 'Sys': 3207 """Return an instance of `Sys` to call methods via this client""" 3208 3209 def user_agreements(self) -> 'UserAgreements': 3210 """Return an instance of `UserAgreements` to call methods via this client""" 3211 3212 def users(self) -> 'Users': 3213 """Return an instance of `Users` to call methods via this client""" 3214 3215 def virtual_machines(self) -> 'VirtualMachines': 3216 """Return an instance of `VirtualMachines` to call methods via this client""" 3217 3218 def vocabularies(self) -> 'Vocabularies': 3219 """Return an instance of `Vocabularies` to call methods via this client""" 3220 3221 def workflows(self) -> 'Workflows': 3222 """Return an instance of `Workflows` to call methods via this client"""
A class for interacting with a resource.
3179 def collections(self) -> 'Collections': 3180 """Return an instance of `Collections` to call methods via this client"""
Return an instance of Collections to call methods via this client
3182 def computed_permissions(self) -> 'ComputedPermissions': 3183 """Return an instance of `ComputedPermissions` to call methods via this client"""
Return an instance of ComputedPermissions to call methods via this client
3185 def configs(self) -> 'Configs': 3186 """Return an instance of `Configs` to call methods via this client"""
Return an instance of Configs to call methods via this client
3188 def container_requests(self) -> 'ContainerRequests': 3189 """Return an instance of `ContainerRequests` to call methods via this client"""
Return an instance of ContainerRequests to call methods via this client
3191 def containers(self) -> 'Containers': 3192 """Return an instance of `Containers` to call methods via this client"""
Return an instance of Containers to call methods via this client
3194 def groups(self) -> 'Groups': 3195 """Return an instance of `Groups` to call methods via this client"""
Return an instance of Groups to call methods via this client
3197 def keep_services(self) -> 'KeepServices': 3198 """Return an instance of `KeepServices` to call methods via this client"""
Return an instance of KeepServices to call methods via this client
3200 def links(self) -> 'Links': 3201 """Return an instance of `Links` to call methods via this client"""
Return an instance of Links to call methods via this client
3203 def logs(self) -> 'Logs': 3204 """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
3209 def user_agreements(self) -> 'UserAgreements': 3210 """Return an instance of `UserAgreements` to call methods via this client"""
Return an instance of UserAgreements to call methods via this client
3212 def users(self) -> 'Users': 3213 """Return an instance of `Users` to call methods via this client"""
Return an instance of Users to call methods via this client
3215 def virtual_machines(self) -> 'VirtualMachines': 3216 """Return an instance of `VirtualMachines` to call methods via this client"""
Return an instance of VirtualMachines to call methods via this client
3218 def vocabularies(self) -> 'Vocabularies': 3219 """Return an instance of `Vocabularies` to call methods via this client"""
Return an instance of Vocabularies to call methods via this client
3221 def workflows(self) -> 'Workflows': 3222 """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