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