arvados.api_resources

   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, Optional, TypeVar
  21if sys.version_info < (3, 8):
  22    from typing_extensions import TypedDict
  23else:
  24    from typing import TypedDict
  25
  26# ST represents an API response type
  27ST = TypeVar('ST', bound=TypedDict)
  28
  29class ApiClient(TypedDict, total=False):
  30    """ApiClient
  31
  32    This is the dictionary object that represents a single ApiClient in Arvados
  33    and is returned by most `ApiClients` methods.
  34    The keys of the dictionary are documented below, along with their types.
  35    Not every key may appear in every dictionary returned by an API call.
  36    When a method doesn't return all the data, you can use its `select` parameter
  37    to list the specific keys you need. Refer to the API documentation for details.
  38    """
  39    uuid: 'str'
  40    etag: 'str'
  41    """Object version."""
  42    owner_uuid: 'str'
  43    modified_by_client_uuid: 'str'
  44    modified_by_user_uuid: 'str'
  45    modified_at: 'str'
  46    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
  47    name: 'str'
  48    url_prefix: 'str'
  49    created_at: 'str'
  50    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
  51    is_trusted: 'bool'
  52
  53
  54class ApiClientAuthorization(TypedDict, total=False):
  55    """ApiClientAuthorization
  56
  57    This is the dictionary object that represents a single ApiClientAuthorization in Arvados
  58    and is returned by most `ApiClientAuthorizations` methods.
  59    The keys of the dictionary are documented below, along with their types.
  60    Not every key may appear in every dictionary returned by an API call.
  61    When a method doesn't return all the data, you can use its `select` parameter
  62    to list the specific keys you need. Refer to the API documentation for details.
  63    """
  64    uuid: 'str'
  65    etag: 'str'
  66    """Object version."""
  67    api_token: 'str'
  68    api_client_id: 'int'
  69    user_id: 'int'
  70    created_by_ip_address: 'str'
  71    last_used_by_ip_address: 'str'
  72    last_used_at: 'str'
  73    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
  74    expires_at: 'str'
  75    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
  76    created_at: 'str'
  77    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
  78    default_owner_uuid: 'str'
  79    scopes: 'List'
  80
  81
  82class ApiClientAuthorizationList(TypedDict, total=False):
  83    """ApiClientAuthorization list
  84
  85    This is the dictionary object returned when you call `ApiClientAuthorizations.list`.
  86    If you just want to iterate all objects that match your search criteria,
  87    consider using `arvados.util.keyset_list_all`.
  88    If you work with this raw object, the keys of the dictionary are documented
  89    below, along with their types. The `items` key maps to a list of matching
  90    `ApiClientAuthorization` objects.
  91    """
  92    kind: 'str' = 'arvados#apiClientAuthorizationList'
  93    """Object type. Always arvados#apiClientAuthorizationList."""
  94    etag: 'str'
  95    """List version."""
  96    items: 'List[ApiClientAuthorization]'
  97    """The list of ApiClientAuthorizations."""
  98    next_link: 'str'
  99    """A link to the next page of ApiClientAuthorizations."""
 100    next_page_token: 'str'
 101    """The page token for the next page of ApiClientAuthorizations."""
 102    selfLink: 'str'
 103    """A link back to this list."""
 104
 105
 106class ApiClientList(TypedDict, total=False):
 107    """ApiClient list
 108
 109    This is the dictionary object returned when you call `ApiClients.list`.
 110    If you just want to iterate all objects that match your search criteria,
 111    consider using `arvados.util.keyset_list_all`.
 112    If you work with this raw object, the keys of the dictionary are documented
 113    below, along with their types. The `items` key maps to a list of matching
 114    `ApiClient` objects.
 115    """
 116    kind: 'str' = 'arvados#apiClientList'
 117    """Object type. Always arvados#apiClientList."""
 118    etag: 'str'
 119    """List version."""
 120    items: 'List[ApiClient]'
 121    """The list of ApiClients."""
 122    next_link: 'str'
 123    """A link to the next page of ApiClients."""
 124    next_page_token: 'str'
 125    """The page token for the next page of ApiClients."""
 126    selfLink: 'str'
 127    """A link back to this list."""
 128
 129
 130class AuthorizedKey(TypedDict, total=False):
 131    """AuthorizedKey
 132
 133    This is the dictionary object that represents a single AuthorizedKey in Arvados
 134    and is returned by most `AuthorizedKeys` methods.
 135    The keys of the dictionary are documented below, along with their types.
 136    Not every key may appear in every dictionary returned by an API call.
 137    When a method doesn't return all the data, you can use its `select` parameter
 138    to list the specific keys you need. Refer to the API documentation for details.
 139    """
 140    uuid: 'str'
 141    etag: 'str'
 142    """Object version."""
 143    owner_uuid: 'str'
 144    modified_by_client_uuid: 'str'
 145    modified_by_user_uuid: 'str'
 146    modified_at: 'str'
 147    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 148    name: 'str'
 149    key_type: 'str'
 150    authorized_user_uuid: 'str'
 151    public_key: 'str'
 152    expires_at: 'str'
 153    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 154    created_at: 'str'
 155    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 156
 157
 158class AuthorizedKeyList(TypedDict, total=False):
 159    """AuthorizedKey list
 160
 161    This is the dictionary object returned when you call `AuthorizedKeys.list`.
 162    If you just want to iterate all objects that match your search criteria,
 163    consider using `arvados.util.keyset_list_all`.
 164    If you work with this raw object, the keys of the dictionary are documented
 165    below, along with their types. The `items` key maps to a list of matching
 166    `AuthorizedKey` objects.
 167    """
 168    kind: 'str' = 'arvados#authorizedKeyList'
 169    """Object type. Always arvados#authorizedKeyList."""
 170    etag: 'str'
 171    """List version."""
 172    items: 'List[AuthorizedKey]'
 173    """The list of AuthorizedKeys."""
 174    next_link: 'str'
 175    """A link to the next page of AuthorizedKeys."""
 176    next_page_token: 'str'
 177    """The page token for the next page of AuthorizedKeys."""
 178    selfLink: 'str'
 179    """A link back to this list."""
 180
 181
 182class Collection(TypedDict, total=False):
 183    """Collection
 184
 185    This is the dictionary object that represents a single Collection in Arvados
 186    and is returned by most `Collections` methods.
 187    The keys of the dictionary are documented below, along with their types.
 188    Not every key may appear in every dictionary returned by an API call.
 189    When a method doesn't return all the data, you can use its `select` parameter
 190    to list the specific keys you need. Refer to the API documentation for details.
 191    """
 192    uuid: 'str'
 193    etag: 'str'
 194    """Object version."""
 195    owner_uuid: 'str'
 196    created_at: 'str'
 197    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 198    modified_by_client_uuid: 'str'
 199    modified_by_user_uuid: 'str'
 200    modified_at: 'str'
 201    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 202    portable_data_hash: 'str'
 203    replication_desired: 'int'
 204    replication_confirmed_at: 'str'
 205    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 206    replication_confirmed: 'int'
 207    manifest_text: 'str'
 208    name: 'str'
 209    description: 'str'
 210    properties: 'Dict[str, Any]'
 211    delete_at: 'str'
 212    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 213    trash_at: 'str'
 214    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 215    is_trashed: 'bool'
 216    storage_classes_desired: 'List'
 217    storage_classes_confirmed: 'List'
 218    storage_classes_confirmed_at: 'str'
 219    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 220    current_version_uuid: 'str'
 221    version: 'int'
 222    preserve_version: 'bool'
 223    file_count: 'int'
 224    file_size_total: 'int'
 225
 226
 227class CollectionList(TypedDict, total=False):
 228    """Collection list
 229
 230    This is the dictionary object returned when you call `Collections.list`.
 231    If you just want to iterate all objects that match your search criteria,
 232    consider using `arvados.util.keyset_list_all`.
 233    If you work with this raw object, the keys of the dictionary are documented
 234    below, along with their types. The `items` key maps to a list of matching
 235    `Collection` objects.
 236    """
 237    kind: 'str' = 'arvados#collectionList'
 238    """Object type. Always arvados#collectionList."""
 239    etag: 'str'
 240    """List version."""
 241    items: 'List[Collection]'
 242    """The list of Collections."""
 243    next_link: 'str'
 244    """A link to the next page of Collections."""
 245    next_page_token: 'str'
 246    """The page token for the next page of Collections."""
 247    selfLink: 'str'
 248    """A link back to this list."""
 249
 250
 251class Container(TypedDict, total=False):
 252    """Container
 253
 254    This is the dictionary object that represents a single Container in Arvados
 255    and is returned by most `Containers` methods.
 256    The keys of the dictionary are documented below, along with their types.
 257    Not every key may appear in every dictionary returned by an API call.
 258    When a method doesn't return all the data, you can use its `select` parameter
 259    to list the specific keys you need. Refer to the API documentation for details.
 260    """
 261    uuid: 'str'
 262    etag: 'str'
 263    """Object version."""
 264    owner_uuid: 'str'
 265    created_at: 'str'
 266    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 267    modified_at: 'str'
 268    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 269    modified_by_client_uuid: 'str'
 270    modified_by_user_uuid: 'str'
 271    state: 'str'
 272    started_at: 'str'
 273    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 274    finished_at: 'str'
 275    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 276    log: 'str'
 277    environment: 'Dict[str, Any]'
 278    cwd: 'str'
 279    command: 'List'
 280    output_path: 'str'
 281    mounts: 'Dict[str, Any]'
 282    runtime_constraints: 'Dict[str, Any]'
 283    output: 'str'
 284    container_image: 'str'
 285    progress: 'float'
 286    priority: 'int'
 287    exit_code: 'int'
 288    auth_uuid: 'str'
 289    locked_by_uuid: 'str'
 290    scheduling_parameters: 'Dict[str, Any]'
 291    runtime_status: 'Dict[str, Any]'
 292    runtime_user_uuid: 'str'
 293    runtime_auth_scopes: 'List'
 294    lock_count: 'int'
 295    gateway_address: 'str'
 296    interactive_session_started: 'bool'
 297    output_storage_classes: 'List'
 298    output_properties: 'Dict[str, Any]'
 299    cost: 'float'
 300    subrequests_cost: 'float'
 301
 302
 303class ContainerList(TypedDict, total=False):
 304    """Container list
 305
 306    This is the dictionary object returned when you call `Containers.list`.
 307    If you just want to iterate all objects that match your search criteria,
 308    consider using `arvados.util.keyset_list_all`.
 309    If you work with this raw object, the keys of the dictionary are documented
 310    below, along with their types. The `items` key maps to a list of matching
 311    `Container` objects.
 312    """
 313    kind: 'str' = 'arvados#containerList'
 314    """Object type. Always arvados#containerList."""
 315    etag: 'str'
 316    """List version."""
 317    items: 'List[Container]'
 318    """The list of Containers."""
 319    next_link: 'str'
 320    """A link to the next page of Containers."""
 321    next_page_token: 'str'
 322    """The page token for the next page of Containers."""
 323    selfLink: 'str'
 324    """A link back to this list."""
 325
 326
 327class ContainerRequest(TypedDict, total=False):
 328    """ContainerRequest
 329
 330    This is the dictionary object that represents a single ContainerRequest in Arvados
 331    and is returned by most `ContainerRequests` methods.
 332    The keys of the dictionary are documented below, along with their types.
 333    Not every key may appear in every dictionary returned by an API call.
 334    When a method doesn't return all the data, you can use its `select` parameter
 335    to list the specific keys you need. Refer to the API documentation for details.
 336    """
 337    uuid: 'str'
 338    etag: 'str'
 339    """Object version."""
 340    owner_uuid: 'str'
 341    created_at: 'str'
 342    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 343    modified_at: 'str'
 344    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 345    modified_by_client_uuid: 'str'
 346    modified_by_user_uuid: 'str'
 347    name: 'str'
 348    description: 'str'
 349    properties: 'Dict[str, Any]'
 350    state: 'str'
 351    requesting_container_uuid: 'str'
 352    container_uuid: 'str'
 353    container_count_max: 'int'
 354    mounts: 'Dict[str, Any]'
 355    runtime_constraints: 'Dict[str, Any]'
 356    container_image: 'str'
 357    environment: 'Dict[str, Any]'
 358    cwd: 'str'
 359    command: 'List'
 360    output_path: 'str'
 361    priority: 'int'
 362    expires_at: 'str'
 363    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 364    filters: 'str'
 365    container_count: 'int'
 366    use_existing: 'bool'
 367    scheduling_parameters: 'Dict[str, Any]'
 368    output_uuid: 'str'
 369    log_uuid: 'str'
 370    output_name: 'str'
 371    output_ttl: 'int'
 372    output_storage_classes: 'List'
 373    output_properties: 'Dict[str, Any]'
 374    cumulative_cost: 'float'
 375
 376
 377class ContainerRequestList(TypedDict, total=False):
 378    """ContainerRequest list
 379
 380    This is the dictionary object returned when you call `ContainerRequests.list`.
 381    If you just want to iterate all objects that match your search criteria,
 382    consider using `arvados.util.keyset_list_all`.
 383    If you work with this raw object, the keys of the dictionary are documented
 384    below, along with their types. The `items` key maps to a list of matching
 385    `ContainerRequest` objects.
 386    """
 387    kind: 'str' = 'arvados#containerRequestList'
 388    """Object type. Always arvados#containerRequestList."""
 389    etag: 'str'
 390    """List version."""
 391    items: 'List[ContainerRequest]'
 392    """The list of ContainerRequests."""
 393    next_link: 'str'
 394    """A link to the next page of ContainerRequests."""
 395    next_page_token: 'str'
 396    """The page token for the next page of ContainerRequests."""
 397    selfLink: 'str'
 398    """A link back to this list."""
 399
 400
 401class Group(TypedDict, total=False):
 402    """Group
 403
 404    This is the dictionary object that represents a single Group in Arvados
 405    and is returned by most `Groups` methods.
 406    The keys of the dictionary are documented below, along with their types.
 407    Not every key may appear in every dictionary returned by an API call.
 408    When a method doesn't return all the data, you can use its `select` parameter
 409    to list the specific keys you need. Refer to the API documentation for details.
 410    """
 411    uuid: 'str'
 412    etag: 'str'
 413    """Object version."""
 414    owner_uuid: 'str'
 415    created_at: 'str'
 416    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 417    modified_by_client_uuid: 'str'
 418    modified_by_user_uuid: 'str'
 419    modified_at: 'str'
 420    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 421    name: 'str'
 422    description: 'str'
 423    group_class: 'str'
 424    trash_at: 'str'
 425    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 426    is_trashed: 'bool'
 427    delete_at: 'str'
 428    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 429    properties: 'Dict[str, Any]'
 430    frozen_by_uuid: 'str'
 431
 432
 433class GroupList(TypedDict, total=False):
 434    """Group list
 435
 436    This is the dictionary object returned when you call `Groups.list`.
 437    If you just want to iterate all objects that match your search criteria,
 438    consider using `arvados.util.keyset_list_all`.
 439    If you work with this raw object, the keys of the dictionary are documented
 440    below, along with their types. The `items` key maps to a list of matching
 441    `Group` objects.
 442    """
 443    kind: 'str' = 'arvados#groupList'
 444    """Object type. Always arvados#groupList."""
 445    etag: 'str'
 446    """List version."""
 447    items: 'List[Group]'
 448    """The list of Groups."""
 449    next_link: 'str'
 450    """A link to the next page of Groups."""
 451    next_page_token: 'str'
 452    """The page token for the next page of Groups."""
 453    selfLink: 'str'
 454    """A link back to this list."""
 455
 456
 457class Human(TypedDict, total=False):
 458    """Human
 459
 460    .. WARNING:: Deprecated
 461       This resource is deprecated in the Arvados API.
 462
 463
 464    This is the dictionary object that represents a single Human in Arvados
 465    and is returned by most `Humans` methods.
 466    The keys of the dictionary are documented below, along with their types.
 467    Not every key may appear in every dictionary returned by an API call.
 468    When a method doesn't return all the data, you can use its `select` parameter
 469    to list the specific keys you need. Refer to the API documentation for details.
 470    """
 471    uuid: 'str'
 472    etag: 'str'
 473    """Object version."""
 474    owner_uuid: 'str'
 475    modified_by_client_uuid: 'str'
 476    modified_by_user_uuid: 'str'
 477    modified_at: 'str'
 478    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 479    properties: 'Dict[str, Any]'
 480    created_at: 'str'
 481    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 482
 483
 484class HumanList(TypedDict, total=False):
 485    """Human list
 486
 487    .. WARNING:: Deprecated
 488       This resource is deprecated in the Arvados API.
 489
 490
 491    This is the dictionary object returned when you call `Humans.list`.
 492    If you just want to iterate all objects that match your search criteria,
 493    consider using `arvados.util.keyset_list_all`.
 494    If you work with this raw object, the keys of the dictionary are documented
 495    below, along with their types. The `items` key maps to a list of matching
 496    `Human` objects.
 497    """
 498    kind: 'str' = 'arvados#humanList'
 499    """Object type. Always arvados#humanList."""
 500    etag: 'str'
 501    """List version."""
 502    items: 'List[Human]'
 503    """The list of Humans."""
 504    next_link: 'str'
 505    """A link to the next page of Humans."""
 506    next_page_token: 'str'
 507    """The page token for the next page of Humans."""
 508    selfLink: 'str'
 509    """A link back to this list."""
 510
 511
 512class Job(TypedDict, total=False):
 513    """Job
 514
 515    .. WARNING:: Deprecated
 516       This resource is deprecated in the Arvados API.
 517
 518
 519    This is the dictionary object that represents a single Job in Arvados
 520    and is returned by most `Jobs` methods.
 521    The keys of the dictionary are documented below, along with their types.
 522    Not every key may appear in every dictionary returned by an API call.
 523    When a method doesn't return all the data, you can use its `select` parameter
 524    to list the specific keys you need. Refer to the API documentation for details.
 525    """
 526    uuid: 'str'
 527    etag: 'str'
 528    """Object version."""
 529    owner_uuid: 'str'
 530    modified_by_client_uuid: 'str'
 531    modified_by_user_uuid: 'str'
 532    modified_at: 'str'
 533    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 534    submit_id: 'str'
 535    script: 'str'
 536    script_version: 'str'
 537    script_parameters: 'Dict[str, Any]'
 538    cancelled_by_client_uuid: 'str'
 539    cancelled_by_user_uuid: 'str'
 540    cancelled_at: 'str'
 541    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 542    started_at: 'str'
 543    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 544    finished_at: 'str'
 545    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 546    running: 'bool'
 547    success: 'bool'
 548    output: 'str'
 549    created_at: 'str'
 550    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 551    is_locked_by_uuid: 'str'
 552    log: 'str'
 553    tasks_summary: 'Dict[str, Any]'
 554    runtime_constraints: 'Dict[str, Any]'
 555    nondeterministic: 'bool'
 556    repository: 'str'
 557    supplied_script_version: 'str'
 558    docker_image_locator: 'str'
 559    priority: 'int'
 560    description: 'str'
 561    state: 'str'
 562    arvados_sdk_version: 'str'
 563    components: 'Dict[str, Any]'
 564
 565
 566class JobList(TypedDict, total=False):
 567    """Job list
 568
 569    .. WARNING:: Deprecated
 570       This resource is deprecated in the Arvados API.
 571
 572
 573    This is the dictionary object returned when you call `Jobs.list`.
 574    If you just want to iterate all objects that match your search criteria,
 575    consider using `arvados.util.keyset_list_all`.
 576    If you work with this raw object, the keys of the dictionary are documented
 577    below, along with their types. The `items` key maps to a list of matching
 578    `Job` objects.
 579    """
 580    kind: 'str' = 'arvados#jobList'
 581    """Object type. Always arvados#jobList."""
 582    etag: 'str'
 583    """List version."""
 584    items: 'List[Job]'
 585    """The list of Jobs."""
 586    next_link: 'str'
 587    """A link to the next page of Jobs."""
 588    next_page_token: 'str'
 589    """The page token for the next page of Jobs."""
 590    selfLink: 'str'
 591    """A link back to this list."""
 592
 593
 594class JobTask(TypedDict, total=False):
 595    """JobTask
 596
 597    .. WARNING:: Deprecated
 598       This resource is deprecated in the Arvados API.
 599
 600
 601    This is the dictionary object that represents a single JobTask in Arvados
 602    and is returned by most `JobTasks` methods.
 603    The keys of the dictionary are documented below, along with their types.
 604    Not every key may appear in every dictionary returned by an API call.
 605    When a method doesn't return all the data, you can use its `select` parameter
 606    to list the specific keys you need. Refer to the API documentation for details.
 607    """
 608    uuid: 'str'
 609    etag: 'str'
 610    """Object version."""
 611    owner_uuid: 'str'
 612    modified_by_client_uuid: 'str'
 613    modified_by_user_uuid: 'str'
 614    modified_at: 'str'
 615    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 616    job_uuid: 'str'
 617    sequence: 'int'
 618    parameters: 'Dict[str, Any]'
 619    output: 'str'
 620    progress: 'float'
 621    success: 'bool'
 622    created_at: 'str'
 623    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 624    created_by_job_task_uuid: 'str'
 625    qsequence: 'int'
 626    started_at: 'str'
 627    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 628    finished_at: 'str'
 629    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 630
 631
 632class JobTaskList(TypedDict, total=False):
 633    """JobTask list
 634
 635    .. WARNING:: Deprecated
 636       This resource is deprecated in the Arvados API.
 637
 638
 639    This is the dictionary object returned when you call `JobTasks.list`.
 640    If you just want to iterate all objects that match your search criteria,
 641    consider using `arvados.util.keyset_list_all`.
 642    If you work with this raw object, the keys of the dictionary are documented
 643    below, along with their types. The `items` key maps to a list of matching
 644    `JobTask` objects.
 645    """
 646    kind: 'str' = 'arvados#jobTaskList'
 647    """Object type. Always arvados#jobTaskList."""
 648    etag: 'str'
 649    """List version."""
 650    items: 'List[JobTask]'
 651    """The list of JobTasks."""
 652    next_link: 'str'
 653    """A link to the next page of JobTasks."""
 654    next_page_token: 'str'
 655    """The page token for the next page of JobTasks."""
 656    selfLink: 'str'
 657    """A link back to this list."""
 658
 659
 660class KeepDisk(TypedDict, total=False):
 661    """KeepDisk
 662
 663    .. WARNING:: Deprecated
 664       This resource is deprecated in the Arvados API.
 665
 666
 667    This is the dictionary object that represents a single KeepDisk in Arvados
 668    and is returned by most `KeepDisks` methods.
 669    The keys of the dictionary are documented below, along with their types.
 670    Not every key may appear in every dictionary returned by an API call.
 671    When a method doesn't return all the data, you can use its `select` parameter
 672    to list the specific keys you need. Refer to the API documentation for details.
 673    """
 674    uuid: 'str'
 675    etag: 'str'
 676    """Object version."""
 677    owner_uuid: 'str'
 678    modified_by_client_uuid: 'str'
 679    modified_by_user_uuid: 'str'
 680    modified_at: 'str'
 681    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 682    node_uuid: 'str'
 683    filesystem_uuid: 'str'
 684    bytes_total: 'int'
 685    bytes_free: 'int'
 686    is_readable: 'bool'
 687    is_writable: 'bool'
 688    last_read_at: 'str'
 689    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 690    last_write_at: 'str'
 691    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 692    last_ping_at: 'str'
 693    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 694    created_at: 'str'
 695    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 696    keep_service_uuid: 'str'
 697
 698
 699class KeepDiskList(TypedDict, total=False):
 700    """KeepDisk list
 701
 702    .. WARNING:: Deprecated
 703       This resource is deprecated in the Arvados API.
 704
 705
 706    This is the dictionary object returned when you call `KeepDisks.list`.
 707    If you just want to iterate all objects that match your search criteria,
 708    consider using `arvados.util.keyset_list_all`.
 709    If you work with this raw object, the keys of the dictionary are documented
 710    below, along with their types. The `items` key maps to a list of matching
 711    `KeepDisk` objects.
 712    """
 713    kind: 'str' = 'arvados#keepDiskList'
 714    """Object type. Always arvados#keepDiskList."""
 715    etag: 'str'
 716    """List version."""
 717    items: 'List[KeepDisk]'
 718    """The list of KeepDisks."""
 719    next_link: 'str'
 720    """A link to the next page of KeepDisks."""
 721    next_page_token: 'str'
 722    """The page token for the next page of KeepDisks."""
 723    selfLink: 'str'
 724    """A link back to this list."""
 725
 726
 727class KeepService(TypedDict, total=False):
 728    """KeepService
 729
 730    This is the dictionary object that represents a single KeepService in Arvados
 731    and is returned by most `KeepServices` methods.
 732    The keys of the dictionary are documented below, along with their types.
 733    Not every key may appear in every dictionary returned by an API call.
 734    When a method doesn't return all the data, you can use its `select` parameter
 735    to list the specific keys you need. Refer to the API documentation for details.
 736    """
 737    uuid: 'str'
 738    etag: 'str'
 739    """Object version."""
 740    owner_uuid: 'str'
 741    modified_by_client_uuid: 'str'
 742    modified_by_user_uuid: 'str'
 743    modified_at: 'str'
 744    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 745    service_host: 'str'
 746    service_port: 'int'
 747    service_ssl_flag: 'bool'
 748    service_type: 'str'
 749    created_at: 'str'
 750    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 751    read_only: 'bool'
 752
 753
 754class KeepServiceList(TypedDict, total=False):
 755    """KeepService list
 756
 757    This is the dictionary object returned when you call `KeepServices.list`.
 758    If you just want to iterate all objects that match your search criteria,
 759    consider using `arvados.util.keyset_list_all`.
 760    If you work with this raw object, the keys of the dictionary are documented
 761    below, along with their types. The `items` key maps to a list of matching
 762    `KeepService` objects.
 763    """
 764    kind: 'str' = 'arvados#keepServiceList'
 765    """Object type. Always arvados#keepServiceList."""
 766    etag: 'str'
 767    """List version."""
 768    items: 'List[KeepService]'
 769    """The list of KeepServices."""
 770    next_link: 'str'
 771    """A link to the next page of KeepServices."""
 772    next_page_token: 'str'
 773    """The page token for the next page of KeepServices."""
 774    selfLink: 'str'
 775    """A link back to this list."""
 776
 777
 778class Link(TypedDict, total=False):
 779    """Link
 780
 781    This is the dictionary object that represents a single Link in Arvados
 782    and is returned by most `Links` methods.
 783    The keys of the dictionary are documented below, along with their types.
 784    Not every key may appear in every dictionary returned by an API call.
 785    When a method doesn't return all the data, you can use its `select` parameter
 786    to list the specific keys you need. Refer to the API documentation for details.
 787    """
 788    uuid: 'str'
 789    etag: 'str'
 790    """Object version."""
 791    owner_uuid: 'str'
 792    created_at: 'str'
 793    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 794    modified_by_client_uuid: 'str'
 795    modified_by_user_uuid: 'str'
 796    modified_at: 'str'
 797    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 798    tail_uuid: 'str'
 799    link_class: 'str'
 800    name: 'str'
 801    head_uuid: 'str'
 802    properties: 'Dict[str, Any]'
 803
 804
 805class LinkList(TypedDict, total=False):
 806    """Link list
 807
 808    This is the dictionary object returned when you call `Links.list`.
 809    If you just want to iterate all objects that match your search criteria,
 810    consider using `arvados.util.keyset_list_all`.
 811    If you work with this raw object, the keys of the dictionary are documented
 812    below, along with their types. The `items` key maps to a list of matching
 813    `Link` objects.
 814    """
 815    kind: 'str' = 'arvados#linkList'
 816    """Object type. Always arvados#linkList."""
 817    etag: 'str'
 818    """List version."""
 819    items: 'List[Link]'
 820    """The list of Links."""
 821    next_link: 'str'
 822    """A link to the next page of Links."""
 823    next_page_token: 'str'
 824    """The page token for the next page of Links."""
 825    selfLink: 'str'
 826    """A link back to this list."""
 827
 828
 829class Log(TypedDict, total=False):
 830    """Log
 831
 832    This is the dictionary object that represents a single Log in Arvados
 833    and is returned by most `Logs` methods.
 834    The keys of the dictionary are documented below, along with their types.
 835    Not every key may appear in every dictionary returned by an API call.
 836    When a method doesn't return all the data, you can use its `select` parameter
 837    to list the specific keys you need. Refer to the API documentation for details.
 838    """
 839    uuid: 'str'
 840    etag: 'str'
 841    """Object version."""
 842    id: 'int'
 843    owner_uuid: 'str'
 844    modified_by_client_uuid: 'str'
 845    modified_by_user_uuid: 'str'
 846    object_uuid: 'str'
 847    event_at: 'str'
 848    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 849    event_type: 'str'
 850    summary: 'str'
 851    properties: 'Dict[str, Any]'
 852    created_at: 'str'
 853    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 854    modified_at: 'str'
 855    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 856    object_owner_uuid: 'str'
 857
 858
 859class LogList(TypedDict, total=False):
 860    """Log list
 861
 862    This is the dictionary object returned when you call `Logs.list`.
 863    If you just want to iterate all objects that match your search criteria,
 864    consider using `arvados.util.keyset_list_all`.
 865    If you work with this raw object, the keys of the dictionary are documented
 866    below, along with their types. The `items` key maps to a list of matching
 867    `Log` objects.
 868    """
 869    kind: 'str' = 'arvados#logList'
 870    """Object type. Always arvados#logList."""
 871    etag: 'str'
 872    """List version."""
 873    items: 'List[Log]'
 874    """The list of Logs."""
 875    next_link: 'str'
 876    """A link to the next page of Logs."""
 877    next_page_token: 'str'
 878    """The page token for the next page of Logs."""
 879    selfLink: 'str'
 880    """A link back to this list."""
 881
 882
 883class Node(TypedDict, total=False):
 884    """Node
 885
 886    .. WARNING:: Deprecated
 887       This resource is deprecated in the Arvados API.
 888
 889
 890    This is the dictionary object that represents a single Node in Arvados
 891    and is returned by most `Nodes` methods.
 892    The keys of the dictionary are documented below, along with their types.
 893    Not every key may appear in every dictionary returned by an API call.
 894    When a method doesn't return all the data, you can use its `select` parameter
 895    to list the specific keys you need. Refer to the API documentation for details.
 896    """
 897    uuid: 'str'
 898    etag: 'str'
 899    """Object version."""
 900    owner_uuid: 'str'
 901    created_at: 'str'
 902    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 903    modified_by_client_uuid: 'str'
 904    modified_by_user_uuid: 'str'
 905    modified_at: 'str'
 906    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 907    slot_number: 'int'
 908    hostname: 'str'
 909    domain: 'str'
 910    ip_address: 'str'
 911    last_ping_at: 'str'
 912    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 913    properties: 'Dict[str, Any]'
 914    job_uuid: 'str'
 915
 916
 917class NodeList(TypedDict, total=False):
 918    """Node list
 919
 920    .. WARNING:: Deprecated
 921       This resource is deprecated in the Arvados API.
 922
 923
 924    This is the dictionary object returned when you call `Nodes.list`.
 925    If you just want to iterate all objects that match your search criteria,
 926    consider using `arvados.util.keyset_list_all`.
 927    If you work with this raw object, the keys of the dictionary are documented
 928    below, along with their types. The `items` key maps to a list of matching
 929    `Node` objects.
 930    """
 931    kind: 'str' = 'arvados#nodeList'
 932    """Object type. Always arvados#nodeList."""
 933    etag: 'str'
 934    """List version."""
 935    items: 'List[Node]'
 936    """The list of Nodes."""
 937    next_link: 'str'
 938    """A link to the next page of Nodes."""
 939    next_page_token: 'str'
 940    """The page token for the next page of Nodes."""
 941    selfLink: 'str'
 942    """A link back to this list."""
 943
 944
 945class PipelineInstance(TypedDict, total=False):
 946    """PipelineInstance
 947
 948    .. WARNING:: Deprecated
 949       This resource is deprecated in the Arvados API.
 950
 951
 952    This is the dictionary object that represents a single PipelineInstance in Arvados
 953    and is returned by most `PipelineInstances` methods.
 954    The keys of the dictionary are documented below, along with their types.
 955    Not every key may appear in every dictionary returned by an API call.
 956    When a method doesn't return all the data, you can use its `select` parameter
 957    to list the specific keys you need. Refer to the API documentation for details.
 958    """
 959    uuid: 'str'
 960    etag: 'str'
 961    """Object version."""
 962    owner_uuid: 'str'
 963    created_at: 'str'
 964    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 965    modified_by_client_uuid: 'str'
 966    modified_by_user_uuid: 'str'
 967    modified_at: 'str'
 968    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 969    pipeline_template_uuid: 'str'
 970    name: 'str'
 971    components: 'Dict[str, Any]'
 972    properties: 'Dict[str, Any]'
 973    state: 'str'
 974    components_summary: 'Dict[str, Any]'
 975    started_at: 'str'
 976    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 977    finished_at: 'str'
 978    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
 979    description: 'str'
 980
 981
 982class PipelineInstanceList(TypedDict, total=False):
 983    """PipelineInstance list
 984
 985    .. WARNING:: Deprecated
 986       This resource is deprecated in the Arvados API.
 987
 988
 989    This is the dictionary object returned when you call `PipelineInstances.list`.
 990    If you just want to iterate all objects that match your search criteria,
 991    consider using `arvados.util.keyset_list_all`.
 992    If you work with this raw object, the keys of the dictionary are documented
 993    below, along with their types. The `items` key maps to a list of matching
 994    `PipelineInstance` objects.
 995    """
 996    kind: 'str' = 'arvados#pipelineInstanceList'
 997    """Object type. Always arvados#pipelineInstanceList."""
 998    etag: 'str'
 999    """List version."""
1000    items: 'List[PipelineInstance]'
1001    """The list of PipelineInstances."""
1002    next_link: 'str'
1003    """A link to the next page of PipelineInstances."""
1004    next_page_token: 'str'
1005    """The page token for the next page of PipelineInstances."""
1006    selfLink: 'str'
1007    """A link back to this list."""
1008
1009
1010class PipelineTemplate(TypedDict, total=False):
1011    """PipelineTemplate
1012
1013    .. WARNING:: Deprecated
1014       This resource is deprecated in the Arvados API.
1015
1016
1017    This is the dictionary object that represents a single PipelineTemplate in Arvados
1018    and is returned by most `PipelineTemplates` methods.
1019    The keys of the dictionary are documented below, along with their types.
1020    Not every key may appear in every dictionary returned by an API call.
1021    When a method doesn't return all the data, you can use its `select` parameter
1022    to list the specific keys you need. Refer to the API documentation for details.
1023    """
1024    uuid: 'str'
1025    etag: 'str'
1026    """Object version."""
1027    owner_uuid: 'str'
1028    created_at: 'str'
1029    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1030    modified_by_client_uuid: 'str'
1031    modified_by_user_uuid: 'str'
1032    modified_at: 'str'
1033    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1034    name: 'str'
1035    components: 'Dict[str, Any]'
1036    description: 'str'
1037
1038
1039class PipelineTemplateList(TypedDict, total=False):
1040    """PipelineTemplate list
1041
1042    .. WARNING:: Deprecated
1043       This resource is deprecated in the Arvados API.
1044
1045
1046    This is the dictionary object returned when you call `PipelineTemplates.list`.
1047    If you just want to iterate all objects that match your search criteria,
1048    consider using `arvados.util.keyset_list_all`.
1049    If you work with this raw object, the keys of the dictionary are documented
1050    below, along with their types. The `items` key maps to a list of matching
1051    `PipelineTemplate` objects.
1052    """
1053    kind: 'str' = 'arvados#pipelineTemplateList'
1054    """Object type. Always arvados#pipelineTemplateList."""
1055    etag: 'str'
1056    """List version."""
1057    items: 'List[PipelineTemplate]'
1058    """The list of PipelineTemplates."""
1059    next_link: 'str'
1060    """A link to the next page of PipelineTemplates."""
1061    next_page_token: 'str'
1062    """The page token for the next page of PipelineTemplates."""
1063    selfLink: 'str'
1064    """A link back to this list."""
1065
1066
1067class Repository(TypedDict, total=False):
1068    """Repository
1069
1070    This is the dictionary object that represents a single Repository in Arvados
1071    and is returned by most `Repositorys` methods.
1072    The keys of the dictionary are documented below, along with their types.
1073    Not every key may appear in every dictionary returned by an API call.
1074    When a method doesn't return all the data, you can use its `select` parameter
1075    to list the specific keys you need. Refer to the API documentation for details.
1076    """
1077    uuid: 'str'
1078    etag: 'str'
1079    """Object version."""
1080    owner_uuid: 'str'
1081    modified_by_client_uuid: 'str'
1082    modified_by_user_uuid: 'str'
1083    modified_at: 'str'
1084    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1085    name: 'str'
1086    created_at: 'str'
1087    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1088
1089
1090class RepositoryList(TypedDict, total=False):
1091    """Repository list
1092
1093    This is the dictionary object returned when you call `Repositorys.list`.
1094    If you just want to iterate all objects that match your search criteria,
1095    consider using `arvados.util.keyset_list_all`.
1096    If you work with this raw object, the keys of the dictionary are documented
1097    below, along with their types. The `items` key maps to a list of matching
1098    `Repository` objects.
1099    """
1100    kind: 'str' = 'arvados#repositoryList'
1101    """Object type. Always arvados#repositoryList."""
1102    etag: 'str'
1103    """List version."""
1104    items: 'List[Repository]'
1105    """The list of Repositories."""
1106    next_link: 'str'
1107    """A link to the next page of Repositories."""
1108    next_page_token: 'str'
1109    """The page token for the next page of Repositories."""
1110    selfLink: 'str'
1111    """A link back to this list."""
1112
1113
1114class Specimen(TypedDict, total=False):
1115    """Specimen
1116
1117    This is the dictionary object that represents a single Specimen in Arvados
1118    and is returned by most `Specimens` methods.
1119    The keys of the dictionary are documented below, along with their types.
1120    Not every key may appear in every dictionary returned by an API call.
1121    When a method doesn't return all the data, you can use its `select` parameter
1122    to list the specific keys you need. Refer to the API documentation for details.
1123    """
1124    uuid: 'str'
1125    etag: 'str'
1126    """Object version."""
1127    owner_uuid: 'str'
1128    created_at: 'str'
1129    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1130    modified_by_client_uuid: 'str'
1131    modified_by_user_uuid: 'str'
1132    modified_at: 'str'
1133    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1134    material: 'str'
1135    properties: 'Dict[str, Any]'
1136
1137
1138class SpecimenList(TypedDict, total=False):
1139    """Specimen list
1140
1141    This is the dictionary object returned when you call `Specimens.list`.
1142    If you just want to iterate all objects that match your search criteria,
1143    consider using `arvados.util.keyset_list_all`.
1144    If you work with this raw object, the keys of the dictionary are documented
1145    below, along with their types. The `items` key maps to a list of matching
1146    `Specimen` objects.
1147    """
1148    kind: 'str' = 'arvados#specimenList'
1149    """Object type. Always arvados#specimenList."""
1150    etag: 'str'
1151    """List version."""
1152    items: 'List[Specimen]'
1153    """The list of Specimens."""
1154    next_link: 'str'
1155    """A link to the next page of Specimens."""
1156    next_page_token: 'str'
1157    """The page token for the next page of Specimens."""
1158    selfLink: 'str'
1159    """A link back to this list."""
1160
1161
1162class Trait(TypedDict, total=False):
1163    """Trait
1164
1165    This is the dictionary object that represents a single Trait in Arvados
1166    and is returned by most `Traits` methods.
1167    The keys of the dictionary are documented below, along with their types.
1168    Not every key may appear in every dictionary returned by an API call.
1169    When a method doesn't return all the data, you can use its `select` parameter
1170    to list the specific keys you need. Refer to the API documentation for details.
1171    """
1172    uuid: 'str'
1173    etag: 'str'
1174    """Object version."""
1175    owner_uuid: 'str'
1176    modified_by_client_uuid: 'str'
1177    modified_by_user_uuid: 'str'
1178    modified_at: 'str'
1179    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1180    name: 'str'
1181    properties: 'Dict[str, Any]'
1182    created_at: 'str'
1183    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1184
1185
1186class TraitList(TypedDict, total=False):
1187    """Trait list
1188
1189    This is the dictionary object returned when you call `Traits.list`.
1190    If you just want to iterate all objects that match your search criteria,
1191    consider using `arvados.util.keyset_list_all`.
1192    If you work with this raw object, the keys of the dictionary are documented
1193    below, along with their types. The `items` key maps to a list of matching
1194    `Trait` objects.
1195    """
1196    kind: 'str' = 'arvados#traitList'
1197    """Object type. Always arvados#traitList."""
1198    etag: 'str'
1199    """List version."""
1200    items: 'List[Trait]'
1201    """The list of Traits."""
1202    next_link: 'str'
1203    """A link to the next page of Traits."""
1204    next_page_token: 'str'
1205    """The page token for the next page of Traits."""
1206    selfLink: 'str'
1207    """A link back to this list."""
1208
1209
1210class User(TypedDict, total=False):
1211    """User
1212
1213    This is the dictionary object that represents a single User in Arvados
1214    and is returned by most `Users` methods.
1215    The keys of the dictionary are documented below, along with their types.
1216    Not every key may appear in every dictionary returned by an API call.
1217    When a method doesn't return all the data, you can use its `select` parameter
1218    to list the specific keys you need. Refer to the API documentation for details.
1219    """
1220    uuid: 'str'
1221    etag: 'str'
1222    """Object version."""
1223    owner_uuid: 'str'
1224    created_at: 'str'
1225    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1226    modified_by_client_uuid: 'str'
1227    modified_by_user_uuid: 'str'
1228    modified_at: 'str'
1229    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1230    email: 'str'
1231    first_name: 'str'
1232    last_name: 'str'
1233    identity_url: 'str'
1234    is_admin: 'bool'
1235    prefs: 'Dict[str, Any]'
1236    is_active: 'bool'
1237    username: 'str'
1238
1239
1240class UserAgreement(TypedDict, total=False):
1241    """UserAgreement
1242
1243    This is the dictionary object that represents a single UserAgreement in Arvados
1244    and is returned by most `UserAgreements` methods.
1245    The keys of the dictionary are documented below, along with their types.
1246    Not every key may appear in every dictionary returned by an API call.
1247    When a method doesn't return all the data, you can use its `select` parameter
1248    to list the specific keys you need. Refer to the API documentation for details.
1249    """
1250    uuid: 'str'
1251    etag: 'str'
1252    """Object version."""
1253    owner_uuid: 'str'
1254    created_at: 'str'
1255    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1256    modified_by_client_uuid: 'str'
1257    modified_by_user_uuid: 'str'
1258    modified_at: 'str'
1259    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1260    portable_data_hash: 'str'
1261    replication_desired: 'int'
1262    replication_confirmed_at: 'str'
1263    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1264    replication_confirmed: 'int'
1265    manifest_text: 'str'
1266    name: 'str'
1267    description: 'str'
1268    properties: 'Dict[str, Any]'
1269    delete_at: 'str'
1270    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1271    trash_at: 'str'
1272    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1273    is_trashed: 'bool'
1274    storage_classes_desired: 'List'
1275    storage_classes_confirmed: 'List'
1276    storage_classes_confirmed_at: 'str'
1277    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1278    current_version_uuid: 'str'
1279    version: 'int'
1280    preserve_version: 'bool'
1281    file_count: 'int'
1282    file_size_total: 'int'
1283
1284
1285class UserAgreementList(TypedDict, total=False):
1286    """UserAgreement list
1287
1288    This is the dictionary object returned when you call `UserAgreements.list`.
1289    If you just want to iterate all objects that match your search criteria,
1290    consider using `arvados.util.keyset_list_all`.
1291    If you work with this raw object, the keys of the dictionary are documented
1292    below, along with their types. The `items` key maps to a list of matching
1293    `UserAgreement` objects.
1294    """
1295    kind: 'str' = 'arvados#userAgreementList'
1296    """Object type. Always arvados#userAgreementList."""
1297    etag: 'str'
1298    """List version."""
1299    items: 'List[UserAgreement]'
1300    """The list of UserAgreements."""
1301    next_link: 'str'
1302    """A link to the next page of UserAgreements."""
1303    next_page_token: 'str'
1304    """The page token for the next page of UserAgreements."""
1305    selfLink: 'str'
1306    """A link back to this list."""
1307
1308
1309class UserList(TypedDict, total=False):
1310    """User list
1311
1312    This is the dictionary object returned when you call `Users.list`.
1313    If you just want to iterate all objects that match your search criteria,
1314    consider using `arvados.util.keyset_list_all`.
1315    If you work with this raw object, the keys of the dictionary are documented
1316    below, along with their types. The `items` key maps to a list of matching
1317    `User` objects.
1318    """
1319    kind: 'str' = 'arvados#userList'
1320    """Object type. Always arvados#userList."""
1321    etag: 'str'
1322    """List version."""
1323    items: 'List[User]'
1324    """The list of Users."""
1325    next_link: 'str'
1326    """A link to the next page of Users."""
1327    next_page_token: 'str'
1328    """The page token for the next page of Users."""
1329    selfLink: 'str'
1330    """A link back to this list."""
1331
1332
1333class VirtualMachine(TypedDict, total=False):
1334    """VirtualMachine
1335
1336    This is the dictionary object that represents a single VirtualMachine in Arvados
1337    and is returned by most `VirtualMachines` methods.
1338    The keys of the dictionary are documented below, along with their types.
1339    Not every key may appear in every dictionary returned by an API call.
1340    When a method doesn't return all the data, you can use its `select` parameter
1341    to list the specific keys you need. Refer to the API documentation for details.
1342    """
1343    uuid: 'str'
1344    etag: 'str'
1345    """Object version."""
1346    owner_uuid: 'str'
1347    modified_by_client_uuid: 'str'
1348    modified_by_user_uuid: 'str'
1349    modified_at: 'str'
1350    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1351    hostname: 'str'
1352    created_at: 'str'
1353    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1354
1355
1356class VirtualMachineList(TypedDict, total=False):
1357    """VirtualMachine list
1358
1359    This is the dictionary object returned when you call `VirtualMachines.list`.
1360    If you just want to iterate all objects that match your search criteria,
1361    consider using `arvados.util.keyset_list_all`.
1362    If you work with this raw object, the keys of the dictionary are documented
1363    below, along with their types. The `items` key maps to a list of matching
1364    `VirtualMachine` objects.
1365    """
1366    kind: 'str' = 'arvados#virtualMachineList'
1367    """Object type. Always arvados#virtualMachineList."""
1368    etag: 'str'
1369    """List version."""
1370    items: 'List[VirtualMachine]'
1371    """The list of VirtualMachines."""
1372    next_link: 'str'
1373    """A link to the next page of VirtualMachines."""
1374    next_page_token: 'str'
1375    """The page token for the next page of VirtualMachines."""
1376    selfLink: 'str'
1377    """A link back to this list."""
1378
1379
1380class Workflow(TypedDict, total=False):
1381    """Workflow
1382
1383    This is the dictionary object that represents a single Workflow in Arvados
1384    and is returned by most `Workflows` methods.
1385    The keys of the dictionary are documented below, along with their types.
1386    Not every key may appear in every dictionary returned by an API call.
1387    When a method doesn't return all the data, you can use its `select` parameter
1388    to list the specific keys you need. Refer to the API documentation for details.
1389    """
1390    uuid: 'str'
1391    etag: 'str'
1392    """Object version."""
1393    owner_uuid: 'str'
1394    created_at: 'str'
1395    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1396    modified_at: 'str'
1397    """String in ISO 8601 datetime format. Pass it to `ciso8601.parse_datetime` to build a `datetime.datetime`."""
1398    modified_by_client_uuid: 'str'
1399    modified_by_user_uuid: 'str'
1400    name: 'str'
1401    description: 'str'
1402    definition: 'str'
1403
1404
1405class WorkflowList(TypedDict, total=False):
1406    """Workflow list
1407
1408    This is the dictionary object returned when you call `Workflows.list`.
1409    If you just want to iterate all objects that match your search criteria,
1410    consider using `arvados.util.keyset_list_all`.
1411    If you work with this raw object, the keys of the dictionary are documented
1412    below, along with their types. The `items` key maps to a list of matching
1413    `Workflow` objects.
1414    """
1415    kind: 'str' = 'arvados#workflowList'
1416    """Object type. Always arvados#workflowList."""
1417    etag: 'str'
1418    """List version."""
1419    items: 'List[Workflow]'
1420    """The list of Workflows."""
1421    next_link: 'str'
1422    """A link to the next page of Workflows."""
1423    next_page_token: 'str'
1424    """The page token for the next page of Workflows."""
1425    selfLink: 'str'
1426    """A link back to this list."""
1427
1428
1429class ApiClientAuthorizations:
1430    """Methods to query and manipulate Arvados api client authorizations"""
1431
1432    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[ApiClientAuthorization]':
1433        """Create a new ApiClientAuthorization.
1434
1435        Optional parameters:
1436
1437        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
1438
1439        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
1440
1441        * select: List --- Attributes of the new object to return in the response.
1442        """
1443
1444    def create_system_auth(self, *, api_client_id: 'int', scopes: 'List') -> 'ArvadosAPIRequest[ApiClientAuthorization]':
1445        """create_system_auth api_client_authorizations
1446
1447        Optional parameters:
1448
1449        * api_client_id: int
1450
1451        * scopes: List
1452        """
1453
1454    def current(self) -> 'ArvadosAPIRequest[ApiClientAuthorization]':
1455        """current api_client_authorizations"""
1456
1457    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ApiClientAuthorization]':
1458        """Delete an existing ApiClientAuthorization.
1459
1460        Required parameters:
1461
1462        * uuid: str --- The UUID of the ApiClientAuthorization in question.
1463        """
1464
1465    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ApiClientAuthorization]':
1466        """Gets a ApiClientAuthorization's metadata by UUID.
1467
1468        Required parameters:
1469
1470        * uuid: str --- The UUID of the ApiClientAuthorization in question.
1471        """
1472
1473    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[ApiClientAuthorizationList]':
1474        """List ApiClientAuthorizations.
1475
1476        Optional parameters:
1477
1478        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
1479
1480        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
1481
1482        * count: str --- Default 'exact'.
1483
1484        * distinct: bool --- Default False.
1485
1486        * filters: List
1487
1488        * limit: int --- Default 100.
1489
1490        * offset: int --- Default 0.
1491
1492        * order: List
1493
1494        * select: List --- Attributes of each object to return in the response.
1495
1496        * where: Dict[str, Any]
1497        """
1498
1499    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[ApiClientAuthorization]':
1500        """Update attributes of an existing ApiClientAuthorization.
1501
1502        Required parameters:
1503
1504        * uuid: str --- The UUID of the ApiClientAuthorization in question.
1505
1506        Optional parameters:
1507
1508        * select: List --- Attributes of the updated object to return in the response.
1509        """
1510
1511
1512class ApiClients:
1513    """Methods to query and manipulate Arvados api clients"""
1514
1515    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[ApiClient]':
1516        """Create a new ApiClient.
1517
1518        Optional parameters:
1519
1520        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
1521
1522        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
1523
1524        * select: List --- Attributes of the new object to return in the response.
1525        """
1526
1527    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ApiClient]':
1528        """Delete an existing ApiClient.
1529
1530        Required parameters:
1531
1532        * uuid: str --- The UUID of the ApiClient in question.
1533        """
1534
1535    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ApiClient]':
1536        """Gets a ApiClient's metadata by UUID.
1537
1538        Required parameters:
1539
1540        * uuid: str --- The UUID of the ApiClient in question.
1541        """
1542
1543    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[ApiClientList]':
1544        """List ApiClients.
1545
1546        Optional parameters:
1547
1548        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
1549
1550        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
1551
1552        * count: str --- Default 'exact'.
1553
1554        * distinct: bool --- Default False.
1555
1556        * filters: List
1557
1558        * limit: int --- Default 100.
1559
1560        * offset: int --- Default 0.
1561
1562        * order: List
1563
1564        * select: List --- Attributes of each object to return in the response.
1565
1566        * where: Dict[str, Any]
1567        """
1568
1569    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[ApiClient]':
1570        """Update attributes of an existing ApiClient.
1571
1572        Required parameters:
1573
1574        * uuid: str --- The UUID of the ApiClient in question.
1575
1576        Optional parameters:
1577
1578        * select: List --- Attributes of the updated object to return in the response.
1579        """
1580
1581
1582class AuthorizedKeys:
1583    """Methods to query and manipulate Arvados authorized keys"""
1584
1585    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[AuthorizedKey]':
1586        """Create a new AuthorizedKey.
1587
1588        Optional parameters:
1589
1590        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
1591
1592        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
1593
1594        * select: List --- Attributes of the new object to return in the response.
1595        """
1596
1597    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[AuthorizedKey]':
1598        """Delete an existing AuthorizedKey.
1599
1600        Required parameters:
1601
1602        * uuid: str --- The UUID of the AuthorizedKey in question.
1603        """
1604
1605    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[AuthorizedKey]':
1606        """Gets a AuthorizedKey's metadata by UUID.
1607
1608        Required parameters:
1609
1610        * uuid: str --- The UUID of the AuthorizedKey in question.
1611        """
1612
1613    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[AuthorizedKeyList]':
1614        """List AuthorizedKeys.
1615
1616        Optional parameters:
1617
1618        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
1619
1620        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
1621
1622        * count: str --- Default 'exact'.
1623
1624        * distinct: bool --- Default False.
1625
1626        * filters: List
1627
1628        * limit: int --- Default 100.
1629
1630        * offset: int --- Default 0.
1631
1632        * order: List
1633
1634        * select: List --- Attributes of each object to return in the response.
1635
1636        * where: Dict[str, Any]
1637        """
1638
1639    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[AuthorizedKey]':
1640        """Update attributes of an existing AuthorizedKey.
1641
1642        Required parameters:
1643
1644        * uuid: str --- The UUID of the AuthorizedKey in question.
1645
1646        Optional parameters:
1647
1648        * select: List --- Attributes of the updated object to return in the response.
1649        """
1650
1651
1652class Collections:
1653    """Methods to query and manipulate Arvados collections"""
1654
1655    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', replace_files: 'Dict[str, Any]', select: 'List') -> 'ArvadosAPIRequest[Collection]':
1656        """Create a new Collection.
1657
1658        Optional parameters:
1659
1660        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
1661
1662        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
1663
1664        * replace_files: Dict[str, Any] --- Files and directories to initialize/replace with content from other collections.
1665
1666        * select: List --- Attributes of the new object to return in the response.
1667        """
1668
1669    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]':
1670        """Delete an existing Collection.
1671
1672        Required parameters:
1673
1674        * uuid: str --- The UUID of the Collection in question.
1675        """
1676
1677    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]':
1678        """Gets a Collection's metadata by UUID.
1679
1680        Required parameters:
1681
1682        * uuid: str --- The UUID of the Collection in question.
1683        """
1684
1685    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', include_old_versions: 'bool', include_trash: 'bool', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[CollectionList]':
1686        """List Collections.
1687
1688        Optional parameters:
1689
1690        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
1691
1692        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
1693
1694        * count: str --- Default 'exact'.
1695
1696        * distinct: bool --- Default False.
1697
1698        * filters: List
1699
1700        * include_old_versions: bool --- Include past collection versions. Default False.
1701
1702        * include_trash: bool --- Include collections whose is_trashed attribute is true. Default False.
1703
1704        * limit: int --- Default 100.
1705
1706        * offset: int --- Default 0.
1707
1708        * order: List
1709
1710        * select: List --- Attributes of each object to return in the response.
1711
1712        * where: Dict[str, Any]
1713        """
1714
1715    def provenance(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]':
1716        """provenance collections
1717
1718        Required parameters:
1719
1720        * uuid: str
1721        """
1722
1723    def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]':
1724        """trash collections
1725
1726        Required parameters:
1727
1728        * uuid: str
1729        """
1730
1731    def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]':
1732        """untrash collections
1733
1734        Required parameters:
1735
1736        * uuid: str
1737        """
1738
1739    def update(self, *, uuid: 'str', replace_files: 'Dict[str, Any]', select: 'List') -> 'ArvadosAPIRequest[Collection]':
1740        """Update attributes of an existing Collection.
1741
1742        Required parameters:
1743
1744        * uuid: str --- The UUID of the Collection in question.
1745
1746        Optional parameters:
1747
1748        * replace_files: Dict[str, Any] --- Files and directories to initialize/replace with content from other collections.
1749
1750        * select: List --- Attributes of the updated object to return in the response.
1751        """
1752
1753    def used_by(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Collection]':
1754        """used_by collections
1755
1756        Required parameters:
1757
1758        * uuid: str
1759        """
1760
1761
1762class Configs:
1763    """Methods to query and manipulate Arvados configs"""
1764
1765    def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]':
1766        """Get public config"""
1767
1768
1769class ContainerRequests:
1770    """Methods to query and manipulate Arvados container requests"""
1771
1772    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[ContainerRequest]':
1773        """Create a new ContainerRequest.
1774
1775        Optional parameters:
1776
1777        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
1778
1779        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
1780
1781        * select: List --- Attributes of the new object to return in the response.
1782        """
1783
1784    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]':
1785        """Delete an existing ContainerRequest.
1786
1787        Required parameters:
1788
1789        * uuid: str --- The UUID of the ContainerRequest in question.
1790        """
1791
1792    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[ContainerRequest]':
1793        """Gets a ContainerRequest's metadata by UUID.
1794
1795        Required parameters:
1796
1797        * uuid: str --- The UUID of the ContainerRequest in question.
1798        """
1799
1800    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', include_trash: 'bool', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[ContainerRequestList]':
1801        """List ContainerRequests.
1802
1803        Optional parameters:
1804
1805        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
1806
1807        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
1808
1809        * count: str --- Default 'exact'.
1810
1811        * distinct: bool --- Default False.
1812
1813        * filters: List
1814
1815        * include_trash: bool --- Include container requests whose owner project is trashed. Default False.
1816
1817        * limit: int --- Default 100.
1818
1819        * offset: int --- Default 0.
1820
1821        * order: List
1822
1823        * select: List --- Attributes of each object to return in the response.
1824
1825        * where: Dict[str, Any]
1826        """
1827
1828    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[ContainerRequest]':
1829        """Update attributes of an existing ContainerRequest.
1830
1831        Required parameters:
1832
1833        * uuid: str --- The UUID of the ContainerRequest in question.
1834
1835        Optional parameters:
1836
1837        * select: List --- Attributes of the updated object to return in the response.
1838        """
1839
1840
1841class Containers:
1842    """Methods to query and manipulate Arvados containers"""
1843
1844    def auth(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]':
1845        """auth containers
1846
1847        Required parameters:
1848
1849        * uuid: str
1850        """
1851
1852    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[Container]':
1853        """Create a new Container.
1854
1855        Optional parameters:
1856
1857        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
1858
1859        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
1860
1861        * select: List --- Attributes of the new object to return in the response.
1862        """
1863
1864    def current(self) -> 'ArvadosAPIRequest[Container]':
1865        """current containers"""
1866
1867    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]':
1868        """Delete an existing Container.
1869
1870        Required parameters:
1871
1872        * uuid: str --- The UUID of the Container in question.
1873        """
1874
1875    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]':
1876        """Gets a Container's metadata by UUID.
1877
1878        Required parameters:
1879
1880        * uuid: str --- The UUID of the Container in question.
1881        """
1882
1883    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[ContainerList]':
1884        """List Containers.
1885
1886        Optional parameters:
1887
1888        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
1889
1890        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
1891
1892        * count: str --- Default 'exact'.
1893
1894        * distinct: bool --- Default False.
1895
1896        * filters: List
1897
1898        * limit: int --- Default 100.
1899
1900        * offset: int --- Default 0.
1901
1902        * order: List
1903
1904        * select: List --- Attributes of each object to return in the response.
1905
1906        * where: Dict[str, Any]
1907        """
1908
1909    def lock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]':
1910        """lock containers
1911
1912        Required parameters:
1913
1914        * uuid: str
1915        """
1916
1917    def secret_mounts(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]':
1918        """secret_mounts containers
1919
1920        Required parameters:
1921
1922        * uuid: str
1923        """
1924
1925    def unlock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]':
1926        """unlock containers
1927
1928        Required parameters:
1929
1930        * uuid: str
1931        """
1932
1933    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[Container]':
1934        """Update attributes of an existing Container.
1935
1936        Required parameters:
1937
1938        * uuid: str --- The UUID of the Container in question.
1939
1940        Optional parameters:
1941
1942        * select: List --- Attributes of the updated object to return in the response.
1943        """
1944
1945    def update_priority(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Container]':
1946        """update_priority containers
1947
1948        Required parameters:
1949
1950        * uuid: str
1951        """
1952
1953
1954class Groups:
1955    """Methods to query and manipulate Arvados groups"""
1956
1957    def contents(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', include: 'str', include_old_versions: 'bool', include_trash: 'bool', limit: 'int', offset: 'int', order: 'List', recursive: 'bool', select: 'List', uuid: 'str', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[Group]':
1958        """contents groups
1959
1960        Optional parameters:
1961
1962        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
1963
1964        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
1965
1966        * count: str --- Default 'exact'.
1967
1968        * distinct: bool --- Default False.
1969
1970        * filters: List
1971
1972        * include: str --- Include objects referred to by listed field in "included" (only owner_uuid).
1973
1974        * include_old_versions: bool --- Include past collection versions. Default False.
1975
1976        * include_trash: bool --- Include items whose is_trashed attribute is true. Default False.
1977
1978        * limit: int --- Default 100.
1979
1980        * offset: int --- Default 0.
1981
1982        * order: List
1983
1984        * recursive: bool --- Include contents from child groups recursively. Default False.
1985
1986        * select: List --- Attributes of each object to return in the response.
1987
1988        * uuid: str --- Default ''.
1989
1990        * where: Dict[str, Any]
1991        """
1992
1993    def create(self, *, async_: 'bool', cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[Group]':
1994        """Create a new Group.
1995
1996        Optional parameters:
1997
1998        * async: bool --- defer permissions update Default False.
1999
2000        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
2001
2002        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
2003
2004        * select: List --- Attributes of the new object to return in the response.
2005        """
2006
2007    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]':
2008        """Delete an existing Group.
2009
2010        Required parameters:
2011
2012        * uuid: str --- The UUID of the Group in question.
2013        """
2014
2015    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]':
2016        """Gets a Group's metadata by UUID.
2017
2018        Required parameters:
2019
2020        * uuid: str --- The UUID of the Group in question.
2021        """
2022
2023    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', include_trash: 'bool', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[GroupList]':
2024        """List Groups.
2025
2026        Optional parameters:
2027
2028        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2029
2030        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2031
2032        * count: str --- Default 'exact'.
2033
2034        * distinct: bool --- Default False.
2035
2036        * filters: List
2037
2038        * include_trash: bool --- Include items whose is_trashed attribute is true. Default False.
2039
2040        * limit: int --- Default 100.
2041
2042        * offset: int --- Default 0.
2043
2044        * order: List
2045
2046        * select: List --- Attributes of each object to return in the response.
2047
2048        * where: Dict[str, Any]
2049        """
2050
2051    def shared(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', include: 'str', include_trash: 'bool', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[Group]':
2052        """shared groups
2053
2054        Optional parameters:
2055
2056        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2057
2058        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2059
2060        * count: str --- Default 'exact'.
2061
2062        * distinct: bool --- Default False.
2063
2064        * filters: List
2065
2066        * include: str
2067
2068        * include_trash: bool --- Include items whose is_trashed attribute is true. Default False.
2069
2070        * limit: int --- Default 100.
2071
2072        * offset: int --- Default 0.
2073
2074        * order: List
2075
2076        * select: List --- Attributes of each object to return in the response.
2077
2078        * where: Dict[str, Any]
2079        """
2080
2081    def trash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]':
2082        """trash groups
2083
2084        Required parameters:
2085
2086        * uuid: str
2087        """
2088
2089    def untrash(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Group]':
2090        """untrash groups
2091
2092        Required parameters:
2093
2094        * uuid: str
2095        """
2096
2097    def update(self, *, uuid: 'str', async_: 'bool', select: 'List') -> 'ArvadosAPIRequest[Group]':
2098        """Update attributes of an existing Group.
2099
2100        Required parameters:
2101
2102        * uuid: str --- The UUID of the Group in question.
2103
2104        Optional parameters:
2105
2106        * async: bool --- defer permissions update Default False.
2107
2108        * select: List --- Attributes of the updated object to return in the response.
2109        """
2110
2111
2112class Humans:
2113    """Methods to query and manipulate Arvados humans
2114
2115    .. WARNING:: Deprecated
2116       This resource is deprecated in the Arvados API.
2117    """
2118
2119    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[Human]':
2120        """Create a new Human.
2121
2122        Optional parameters:
2123
2124        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
2125
2126        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
2127
2128        * select: List --- Attributes of the new object to return in the response.
2129        """
2130
2131    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Human]':
2132        """Delete an existing Human.
2133
2134        Required parameters:
2135
2136        * uuid: str --- The UUID of the Human in question.
2137        """
2138
2139    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Human]':
2140        """Gets a Human's metadata by UUID.
2141
2142        Required parameters:
2143
2144        * uuid: str --- The UUID of the Human in question.
2145        """
2146
2147    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[HumanList]':
2148        """List Humans.
2149
2150        Optional parameters:
2151
2152        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2153
2154        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2155
2156        * count: str --- Default 'exact'.
2157
2158        * distinct: bool --- Default False.
2159
2160        * filters: List
2161
2162        * limit: int --- Default 100.
2163
2164        * offset: int --- Default 0.
2165
2166        * order: List
2167
2168        * select: List --- Attributes of each object to return in the response.
2169
2170        * where: Dict[str, Any]
2171        """
2172
2173    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[Human]':
2174        """Update attributes of an existing Human.
2175
2176        Required parameters:
2177
2178        * uuid: str --- The UUID of the Human in question.
2179
2180        Optional parameters:
2181
2182        * select: List --- Attributes of the updated object to return in the response.
2183        """
2184
2185
2186class JobTasks:
2187    """Methods to query and manipulate Arvados job tasks
2188
2189    .. WARNING:: Deprecated
2190       This resource is deprecated in the Arvados API.
2191    """
2192
2193    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[JobTask]':
2194        """Create a new JobTask.
2195
2196        Optional parameters:
2197
2198        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
2199
2200        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
2201
2202        * select: List --- Attributes of the new object to return in the response.
2203        """
2204
2205    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[JobTask]':
2206        """Delete an existing JobTask.
2207
2208        Required parameters:
2209
2210        * uuid: str --- The UUID of the JobTask in question.
2211        """
2212
2213    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[JobTask]':
2214        """Gets a JobTask's metadata by UUID.
2215
2216        Required parameters:
2217
2218        * uuid: str --- The UUID of the JobTask in question.
2219        """
2220
2221    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[JobTaskList]':
2222        """List JobTasks.
2223
2224        Optional parameters:
2225
2226        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2227
2228        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2229
2230        * count: str --- Default 'exact'.
2231
2232        * distinct: bool --- Default False.
2233
2234        * filters: List
2235
2236        * limit: int --- Default 100.
2237
2238        * offset: int --- Default 0.
2239
2240        * order: List
2241
2242        * select: List --- Attributes of each object to return in the response.
2243
2244        * where: Dict[str, Any]
2245        """
2246
2247    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[JobTask]':
2248        """Update attributes of an existing JobTask.
2249
2250        Required parameters:
2251
2252        * uuid: str --- The UUID of the JobTask in question.
2253
2254        Optional parameters:
2255
2256        * select: List --- Attributes of the updated object to return in the response.
2257        """
2258
2259
2260class Jobs:
2261    """Methods to query and manipulate Arvados jobs
2262
2263    .. WARNING:: Deprecated
2264       This resource is deprecated in the Arvados API.
2265    """
2266
2267    def cancel(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Job]':
2268        """cancel jobs
2269
2270        Required parameters:
2271
2272        * uuid: str
2273        """
2274
2275    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', exclude_script_versions: 'List', filters: 'List', find_or_create: 'bool', minimum_script_version: 'str', select: 'List') -> 'ArvadosAPIRequest[Job]':
2276        """Create a new Job.
2277
2278        Optional parameters:
2279
2280        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
2281
2282        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
2283
2284        * exclude_script_versions: List
2285
2286        * filters: List
2287
2288        * find_or_create: bool --- Default False.
2289
2290        * minimum_script_version: str
2291
2292        * select: List --- Attributes of the new object to return in the response.
2293        """
2294
2295    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Job]':
2296        """Delete an existing Job.
2297
2298        Required parameters:
2299
2300        * uuid: str --- The UUID of the Job in question.
2301        """
2302
2303    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Job]':
2304        """Gets a Job's metadata by UUID.
2305
2306        Required parameters:
2307
2308        * uuid: str --- The UUID of the Job in question.
2309        """
2310
2311    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[JobList]':
2312        """List Jobs.
2313
2314        Optional parameters:
2315
2316        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2317
2318        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2319
2320        * count: str --- Default 'exact'.
2321
2322        * distinct: bool --- Default False.
2323
2324        * filters: List
2325
2326        * limit: int --- Default 100.
2327
2328        * offset: int --- Default 0.
2329
2330        * order: List
2331
2332        * select: List --- Attributes of each object to return in the response.
2333
2334        * where: Dict[str, Any]
2335        """
2336
2337    def lock(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Job]':
2338        """lock jobs
2339
2340        Required parameters:
2341
2342        * uuid: str
2343        """
2344
2345    def queue(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[Job]':
2346        """queue jobs
2347
2348        Optional parameters:
2349
2350        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2351
2352        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2353
2354        * count: str --- Default 'exact'.
2355
2356        * distinct: bool --- Default False.
2357
2358        * filters: List
2359
2360        * limit: int --- Default 100.
2361
2362        * offset: int --- Default 0.
2363
2364        * order: List
2365
2366        * select: List --- Attributes of each object to return in the response.
2367
2368        * where: Dict[str, Any]
2369        """
2370
2371    def queue_size(self) -> 'ArvadosAPIRequest[Job]':
2372        """queue_size jobs"""
2373
2374    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[Job]':
2375        """Update attributes of an existing Job.
2376
2377        Required parameters:
2378
2379        * uuid: str --- The UUID of the Job in question.
2380
2381        Optional parameters:
2382
2383        * select: List --- Attributes of the updated object to return in the response.
2384        """
2385
2386
2387class KeepDisks:
2388    """Methods to query and manipulate Arvados keep disks
2389
2390    .. WARNING:: Deprecated
2391       This resource is deprecated in the Arvados API.
2392    """
2393
2394    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[KeepDisk]':
2395        """Create a new KeepDisk.
2396
2397        Optional parameters:
2398
2399        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
2400
2401        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
2402
2403        * select: List --- Attributes of the new object to return in the response.
2404        """
2405
2406    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[KeepDisk]':
2407        """Delete an existing KeepDisk.
2408
2409        Required parameters:
2410
2411        * uuid: str --- The UUID of the KeepDisk in question.
2412        """
2413
2414    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[KeepDisk]':
2415        """Gets a KeepDisk's metadata by UUID.
2416
2417        Required parameters:
2418
2419        * uuid: str --- The UUID of the KeepDisk in question.
2420        """
2421
2422    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[KeepDiskList]':
2423        """List KeepDisks.
2424
2425        Optional parameters:
2426
2427        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2428
2429        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2430
2431        * count: str --- Default 'exact'.
2432
2433        * distinct: bool --- Default False.
2434
2435        * filters: List
2436
2437        * limit: int --- Default 100.
2438
2439        * offset: int --- Default 0.
2440
2441        * order: List
2442
2443        * select: List --- Attributes of each object to return in the response.
2444
2445        * where: Dict[str, Any]
2446        """
2447
2448    def ping(self, *, ping_secret: 'str', service_port: 'str', service_ssl_flag: 'str', filesystem_uuid: 'str', node_uuid: 'str', service_host: 'str', uuid: 'str') -> 'ArvadosAPIRequest[KeepDisk]':
2449        """ping keep_disks
2450
2451        Required parameters:
2452
2453        * ping_secret: str
2454
2455        * service_port: str
2456
2457        * service_ssl_flag: str
2458
2459        Optional parameters:
2460
2461        * filesystem_uuid: str
2462
2463        * node_uuid: str
2464
2465        * service_host: str
2466
2467        * uuid: str
2468        """
2469
2470    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[KeepDisk]':
2471        """Update attributes of an existing KeepDisk.
2472
2473        Required parameters:
2474
2475        * uuid: str --- The UUID of the KeepDisk in question.
2476
2477        Optional parameters:
2478
2479        * select: List --- Attributes of the updated object to return in the response.
2480        """
2481
2482
2483class KeepServices:
2484    """Methods to query and manipulate Arvados keep services"""
2485
2486    def accessible(self) -> 'ArvadosAPIRequest[KeepService]':
2487        """accessible keep_services"""
2488
2489    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[KeepService]':
2490        """Create a new KeepService.
2491
2492        Optional parameters:
2493
2494        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
2495
2496        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
2497
2498        * select: List --- Attributes of the new object to return in the response.
2499        """
2500
2501    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[KeepService]':
2502        """Delete an existing KeepService.
2503
2504        Required parameters:
2505
2506        * uuid: str --- The UUID of the KeepService in question.
2507        """
2508
2509    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[KeepService]':
2510        """Gets a KeepService's metadata by UUID.
2511
2512        Required parameters:
2513
2514        * uuid: str --- The UUID of the KeepService in question.
2515        """
2516
2517    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[KeepServiceList]':
2518        """List KeepServices.
2519
2520        Optional parameters:
2521
2522        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2523
2524        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2525
2526        * count: str --- Default 'exact'.
2527
2528        * distinct: bool --- Default False.
2529
2530        * filters: List
2531
2532        * limit: int --- Default 100.
2533
2534        * offset: int --- Default 0.
2535
2536        * order: List
2537
2538        * select: List --- Attributes of each object to return in the response.
2539
2540        * where: Dict[str, Any]
2541        """
2542
2543    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[KeepService]':
2544        """Update attributes of an existing KeepService.
2545
2546        Required parameters:
2547
2548        * uuid: str --- The UUID of the KeepService in question.
2549
2550        Optional parameters:
2551
2552        * select: List --- Attributes of the updated object to return in the response.
2553        """
2554
2555
2556class Links:
2557    """Methods to query and manipulate Arvados links"""
2558
2559    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[Link]':
2560        """Create a new Link.
2561
2562        Optional parameters:
2563
2564        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
2565
2566        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
2567
2568        * select: List --- Attributes of the new object to return in the response.
2569        """
2570
2571    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]':
2572        """Delete an existing Link.
2573
2574        Required parameters:
2575
2576        * uuid: str --- The UUID of the Link in question.
2577        """
2578
2579    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]':
2580        """Gets a Link's metadata by UUID.
2581
2582        Required parameters:
2583
2584        * uuid: str --- The UUID of the Link in question.
2585        """
2586
2587    def get_permissions(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Link]':
2588        """get_permissions links
2589
2590        Required parameters:
2591
2592        * uuid: str
2593        """
2594
2595    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[LinkList]':
2596        """List Links.
2597
2598        Optional parameters:
2599
2600        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2601
2602        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2603
2604        * count: str --- Default 'exact'.
2605
2606        * distinct: bool --- Default False.
2607
2608        * filters: List
2609
2610        * limit: int --- Default 100.
2611
2612        * offset: int --- Default 0.
2613
2614        * order: List
2615
2616        * select: List --- Attributes of each object to return in the response.
2617
2618        * where: Dict[str, Any]
2619        """
2620
2621    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[Link]':
2622        """Update attributes of an existing Link.
2623
2624        Required parameters:
2625
2626        * uuid: str --- The UUID of the Link in question.
2627
2628        Optional parameters:
2629
2630        * select: List --- Attributes of the updated object to return in the response.
2631        """
2632
2633
2634class Logs:
2635    """Methods to query and manipulate Arvados logs"""
2636
2637    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[Log]':
2638        """Create a new Log.
2639
2640        Optional parameters:
2641
2642        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
2643
2644        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
2645
2646        * select: List --- Attributes of the new object to return in the response.
2647        """
2648
2649    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Log]':
2650        """Delete an existing Log.
2651
2652        Required parameters:
2653
2654        * uuid: str --- The UUID of the Log in question.
2655        """
2656
2657    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Log]':
2658        """Gets a Log's metadata by UUID.
2659
2660        Required parameters:
2661
2662        * uuid: str --- The UUID of the Log in question.
2663        """
2664
2665    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[LogList]':
2666        """List Logs.
2667
2668        Optional parameters:
2669
2670        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2671
2672        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2673
2674        * count: str --- Default 'exact'.
2675
2676        * distinct: bool --- Default False.
2677
2678        * filters: List
2679
2680        * limit: int --- Default 100.
2681
2682        * offset: int --- Default 0.
2683
2684        * order: List
2685
2686        * select: List --- Attributes of each object to return in the response.
2687
2688        * where: Dict[str, Any]
2689        """
2690
2691    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[Log]':
2692        """Update attributes of an existing Log.
2693
2694        Required parameters:
2695
2696        * uuid: str --- The UUID of the Log in question.
2697
2698        Optional parameters:
2699
2700        * select: List --- Attributes of the updated object to return in the response.
2701        """
2702
2703
2704class Nodes:
2705    """Methods to query and manipulate Arvados nodes
2706
2707    .. WARNING:: Deprecated
2708       This resource is deprecated in the Arvados API.
2709    """
2710
2711    def create(self, *, assign_slot: 'bool', cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[Node]':
2712        """Create a new Node.
2713
2714        Optional parameters:
2715
2716        * assign_slot: bool --- assign slot and hostname
2717
2718        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
2719
2720        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
2721
2722        * select: List --- Attributes of the new object to return in the response.
2723        """
2724
2725    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Node]':
2726        """Delete an existing Node.
2727
2728        Required parameters:
2729
2730        * uuid: str --- The UUID of the Node in question.
2731        """
2732
2733    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Node]':
2734        """Gets a Node's metadata by UUID.
2735
2736        Required parameters:
2737
2738        * uuid: str --- The UUID of the Node in question.
2739        """
2740
2741    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[NodeList]':
2742        """List Nodes.
2743
2744        Optional parameters:
2745
2746        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2747
2748        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2749
2750        * count: str --- Default 'exact'.
2751
2752        * distinct: bool --- Default False.
2753
2754        * filters: List
2755
2756        * limit: int --- Default 100.
2757
2758        * offset: int --- Default 0.
2759
2760        * order: List
2761
2762        * select: List --- Attributes of each object to return in the response.
2763
2764        * where: Dict[str, Any]
2765        """
2766
2767    def ping(self, *, ping_secret: 'str', uuid: 'str') -> 'ArvadosAPIRequest[Node]':
2768        """ping nodes
2769
2770        Required parameters:
2771
2772        * ping_secret: str
2773
2774        * uuid: str
2775        """
2776
2777    def update(self, *, uuid: 'str', assign_slot: 'bool', select: 'List') -> 'ArvadosAPIRequest[Node]':
2778        """Update attributes of an existing Node.
2779
2780        Required parameters:
2781
2782        * uuid: str --- The UUID of the Node in question.
2783
2784        Optional parameters:
2785
2786        * assign_slot: bool --- assign slot and hostname
2787
2788        * select: List --- Attributes of the updated object to return in the response.
2789        """
2790
2791
2792class PipelineInstances:
2793    """Methods to query and manipulate Arvados pipeline instances
2794
2795    .. WARNING:: Deprecated
2796       This resource is deprecated in the Arvados API.
2797    """
2798
2799    def cancel(self, *, uuid: 'str') -> 'ArvadosAPIRequest[PipelineInstance]':
2800        """cancel pipeline_instances
2801
2802        Required parameters:
2803
2804        * uuid: str
2805        """
2806
2807    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[PipelineInstance]':
2808        """Create a new PipelineInstance.
2809
2810        Optional parameters:
2811
2812        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
2813
2814        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
2815
2816        * select: List --- Attributes of the new object to return in the response.
2817        """
2818
2819    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[PipelineInstance]':
2820        """Delete an existing PipelineInstance.
2821
2822        Required parameters:
2823
2824        * uuid: str --- The UUID of the PipelineInstance in question.
2825        """
2826
2827    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[PipelineInstance]':
2828        """Gets a PipelineInstance's metadata by UUID.
2829
2830        Required parameters:
2831
2832        * uuid: str --- The UUID of the PipelineInstance in question.
2833        """
2834
2835    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[PipelineInstanceList]':
2836        """List PipelineInstances.
2837
2838        Optional parameters:
2839
2840        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2841
2842        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2843
2844        * count: str --- Default 'exact'.
2845
2846        * distinct: bool --- Default False.
2847
2848        * filters: List
2849
2850        * limit: int --- Default 100.
2851
2852        * offset: int --- Default 0.
2853
2854        * order: List
2855
2856        * select: List --- Attributes of each object to return in the response.
2857
2858        * where: Dict[str, Any]
2859        """
2860
2861    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[PipelineInstance]':
2862        """Update attributes of an existing PipelineInstance.
2863
2864        Required parameters:
2865
2866        * uuid: str --- The UUID of the PipelineInstance in question.
2867
2868        Optional parameters:
2869
2870        * select: List --- Attributes of the updated object to return in the response.
2871        """
2872
2873
2874class PipelineTemplates:
2875    """Methods to query and manipulate Arvados pipeline templates
2876
2877    .. WARNING:: Deprecated
2878       This resource is deprecated in the Arvados API.
2879    """
2880
2881    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[PipelineTemplate]':
2882        """Create a new PipelineTemplate.
2883
2884        Optional parameters:
2885
2886        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
2887
2888        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
2889
2890        * select: List --- Attributes of the new object to return in the response.
2891        """
2892
2893    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[PipelineTemplate]':
2894        """Delete an existing PipelineTemplate.
2895
2896        Required parameters:
2897
2898        * uuid: str --- The UUID of the PipelineTemplate in question.
2899        """
2900
2901    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[PipelineTemplate]':
2902        """Gets a PipelineTemplate's metadata by UUID.
2903
2904        Required parameters:
2905
2906        * uuid: str --- The UUID of the PipelineTemplate in question.
2907        """
2908
2909    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[PipelineTemplateList]':
2910        """List PipelineTemplates.
2911
2912        Optional parameters:
2913
2914        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2915
2916        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2917
2918        * count: str --- Default 'exact'.
2919
2920        * distinct: bool --- Default False.
2921
2922        * filters: List
2923
2924        * limit: int --- Default 100.
2925
2926        * offset: int --- Default 0.
2927
2928        * order: List
2929
2930        * select: List --- Attributes of each object to return in the response.
2931
2932        * where: Dict[str, Any]
2933        """
2934
2935    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[PipelineTemplate]':
2936        """Update attributes of an existing PipelineTemplate.
2937
2938        Required parameters:
2939
2940        * uuid: str --- The UUID of the PipelineTemplate in question.
2941
2942        Optional parameters:
2943
2944        * select: List --- Attributes of the updated object to return in the response.
2945        """
2946
2947
2948class Repositories:
2949    """Methods to query and manipulate Arvados repositories"""
2950
2951    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[Repository]':
2952        """Create a new Repository.
2953
2954        Optional parameters:
2955
2956        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
2957
2958        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
2959
2960        * select: List --- Attributes of the new object to return in the response.
2961        """
2962
2963    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Repository]':
2964        """Delete an existing Repository.
2965
2966        Required parameters:
2967
2968        * uuid: str --- The UUID of the Repository in question.
2969        """
2970
2971    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Repository]':
2972        """Gets a Repository's metadata by UUID.
2973
2974        Required parameters:
2975
2976        * uuid: str --- The UUID of the Repository in question.
2977        """
2978
2979    def get_all_permissions(self) -> 'ArvadosAPIRequest[Repository]':
2980        """get_all_permissions repositories"""
2981
2982    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[RepositoryList]':
2983        """List Repositories.
2984
2985        Optional parameters:
2986
2987        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
2988
2989        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
2990
2991        * count: str --- Default 'exact'.
2992
2993        * distinct: bool --- Default False.
2994
2995        * filters: List
2996
2997        * limit: int --- Default 100.
2998
2999        * offset: int --- Default 0.
3000
3001        * order: List
3002
3003        * select: List --- Attributes of each object to return in the response.
3004
3005        * where: Dict[str, Any]
3006        """
3007
3008    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[Repository]':
3009        """Update attributes of an existing Repository.
3010
3011        Required parameters:
3012
3013        * uuid: str --- The UUID of the Repository in question.
3014
3015        Optional parameters:
3016
3017        * select: List --- Attributes of the updated object to return in the response.
3018        """
3019
3020
3021class Specimens:
3022    """Methods to query and manipulate Arvados specimens"""
3023
3024    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[Specimen]':
3025        """Create a new Specimen.
3026
3027        Optional parameters:
3028
3029        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
3030
3031        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
3032
3033        * select: List --- Attributes of the new object to return in the response.
3034        """
3035
3036    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Specimen]':
3037        """Delete an existing Specimen.
3038
3039        Required parameters:
3040
3041        * uuid: str --- The UUID of the Specimen in question.
3042        """
3043
3044    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Specimen]':
3045        """Gets a Specimen's metadata by UUID.
3046
3047        Required parameters:
3048
3049        * uuid: str --- The UUID of the Specimen in question.
3050        """
3051
3052    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[SpecimenList]':
3053        """List Specimens.
3054
3055        Optional parameters:
3056
3057        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
3058
3059        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
3060
3061        * count: str --- Default 'exact'.
3062
3063        * distinct: bool --- Default False.
3064
3065        * filters: List
3066
3067        * limit: int --- Default 100.
3068
3069        * offset: int --- Default 0.
3070
3071        * order: List
3072
3073        * select: List --- Attributes of each object to return in the response.
3074
3075        * where: Dict[str, Any]
3076        """
3077
3078    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[Specimen]':
3079        """Update attributes of an existing Specimen.
3080
3081        Required parameters:
3082
3083        * uuid: str --- The UUID of the Specimen in question.
3084
3085        Optional parameters:
3086
3087        * select: List --- Attributes of the updated object to return in the response.
3088        """
3089
3090
3091class Sys:
3092    """Methods to query and manipulate Arvados sys"""
3093
3094    def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]':
3095        """apply scheduled trash and delete operations"""
3096
3097
3098class Traits:
3099    """Methods to query and manipulate Arvados traits"""
3100
3101    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[Trait]':
3102        """Create a new Trait.
3103
3104        Optional parameters:
3105
3106        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
3107
3108        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
3109
3110        * select: List --- Attributes of the new object to return in the response.
3111        """
3112
3113    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Trait]':
3114        """Delete an existing Trait.
3115
3116        Required parameters:
3117
3118        * uuid: str --- The UUID of the Trait in question.
3119        """
3120
3121    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Trait]':
3122        """Gets a Trait's metadata by UUID.
3123
3124        Required parameters:
3125
3126        * uuid: str --- The UUID of the Trait in question.
3127        """
3128
3129    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[TraitList]':
3130        """List Traits.
3131
3132        Optional parameters:
3133
3134        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
3135
3136        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
3137
3138        * count: str --- Default 'exact'.
3139
3140        * distinct: bool --- Default False.
3141
3142        * filters: List
3143
3144        * limit: int --- Default 100.
3145
3146        * offset: int --- Default 0.
3147
3148        * order: List
3149
3150        * select: List --- Attributes of each object to return in the response.
3151
3152        * where: Dict[str, Any]
3153        """
3154
3155    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[Trait]':
3156        """Update attributes of an existing Trait.
3157
3158        Required parameters:
3159
3160        * uuid: str --- The UUID of the Trait in question.
3161
3162        Optional parameters:
3163
3164        * select: List --- Attributes of the updated object to return in the response.
3165        """
3166
3167
3168class UserAgreements:
3169    """Methods to query and manipulate Arvados user agreements"""
3170
3171    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[UserAgreement]':
3172        """Create a new UserAgreement.
3173
3174        Optional parameters:
3175
3176        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
3177
3178        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
3179
3180        * select: List --- Attributes of the new object to return in the response.
3181        """
3182
3183    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[UserAgreement]':
3184        """Delete an existing UserAgreement.
3185
3186        Required parameters:
3187
3188        * uuid: str --- The UUID of the UserAgreement in question.
3189        """
3190
3191    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[UserAgreement]':
3192        """Gets a UserAgreement's metadata by UUID.
3193
3194        Required parameters:
3195
3196        * uuid: str --- The UUID of the UserAgreement in question.
3197        """
3198
3199    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[UserAgreementList]':
3200        """List UserAgreements.
3201
3202        Optional parameters:
3203
3204        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
3205
3206        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
3207
3208        * count: str --- Default 'exact'.
3209
3210        * distinct: bool --- Default False.
3211
3212        * filters: List
3213
3214        * limit: int --- Default 100.
3215
3216        * offset: int --- Default 0.
3217
3218        * order: List
3219
3220        * select: List --- Attributes of each object to return in the response.
3221
3222        * where: Dict[str, Any]
3223        """
3224
3225    def new(self) -> 'ArvadosAPIRequest[UserAgreement]':
3226        """new user_agreements"""
3227
3228    def sign(self) -> 'ArvadosAPIRequest[UserAgreement]':
3229        """sign user_agreements"""
3230
3231    def signatures(self) -> 'ArvadosAPIRequest[UserAgreement]':
3232        """signatures user_agreements"""
3233
3234    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[UserAgreement]':
3235        """Update attributes of an existing UserAgreement.
3236
3237        Required parameters:
3238
3239        * uuid: str --- The UUID of the UserAgreement in question.
3240
3241        Optional parameters:
3242
3243        * select: List --- Attributes of the updated object to return in the response.
3244        """
3245
3246
3247class Users:
3248    """Methods to query and manipulate Arvados users"""
3249
3250    def activate(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]':
3251        """activate users
3252
3253        Required parameters:
3254
3255        * uuid: str
3256        """
3257
3258    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[User]':
3259        """Create a new User.
3260
3261        Optional parameters:
3262
3263        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
3264
3265        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
3266
3267        * select: List --- Attributes of the new object to return in the response.
3268        """
3269
3270    def current(self) -> 'ArvadosAPIRequest[User]':
3271        """current users"""
3272
3273    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]':
3274        """Delete an existing User.
3275
3276        Required parameters:
3277
3278        * uuid: str --- The UUID of the User in question.
3279        """
3280
3281    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]':
3282        """Gets a User's metadata by UUID.
3283
3284        Required parameters:
3285
3286        * uuid: str --- The UUID of the User in question.
3287        """
3288
3289    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[UserList]':
3290        """List Users.
3291
3292        Optional parameters:
3293
3294        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
3295
3296        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
3297
3298        * count: str --- Default 'exact'.
3299
3300        * distinct: bool --- Default False.
3301
3302        * filters: List
3303
3304        * limit: int --- Default 100.
3305
3306        * offset: int --- Default 0.
3307
3308        * order: List
3309
3310        * select: List --- Attributes of each object to return in the response.
3311
3312        * where: Dict[str, Any]
3313        """
3314
3315    def merge(self, *, new_owner_uuid: 'str', new_user_token: 'str', new_user_uuid: 'str', old_user_uuid: 'str', redirect_to_new_user: 'bool') -> 'ArvadosAPIRequest[User]':
3316        """merge users
3317
3318        Required parameters:
3319
3320        * new_owner_uuid: str
3321
3322        Optional parameters:
3323
3324        * new_user_token: str
3325
3326        * new_user_uuid: str
3327
3328        * old_user_uuid: str
3329
3330        * redirect_to_new_user: bool --- Default False.
3331        """
3332
3333    def setup(self, *, repo_name: 'str', send_notification_email: 'bool', user: 'Dict[str, Any]', uuid: 'str', vm_uuid: 'str') -> 'ArvadosAPIRequest[User]':
3334        """setup users
3335
3336        Optional parameters:
3337
3338        * repo_name: str
3339
3340        * send_notification_email: bool --- Default False.
3341
3342        * user: Dict[str, Any]
3343
3344        * uuid: str
3345
3346        * vm_uuid: str
3347        """
3348
3349    def system(self) -> 'ArvadosAPIRequest[User]':
3350        """system users"""
3351
3352    def unsetup(self, *, uuid: 'str') -> 'ArvadosAPIRequest[User]':
3353        """unsetup users
3354
3355        Required parameters:
3356
3357        * uuid: str
3358        """
3359
3360    def update(self, *, uuid: 'str', bypass_federation: 'bool', select: 'List') -> 'ArvadosAPIRequest[User]':
3361        """Update attributes of an existing User.
3362
3363        Required parameters:
3364
3365        * uuid: str --- The UUID of the User in question.
3366
3367        Optional parameters:
3368
3369        * bypass_federation: bool --- Default False.
3370
3371        * select: List --- Attributes of the updated object to return in the response.
3372        """
3373
3374
3375class VirtualMachines:
3376    """Methods to query and manipulate Arvados virtual machines"""
3377
3378    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[VirtualMachine]':
3379        """Create a new VirtualMachine.
3380
3381        Optional parameters:
3382
3383        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
3384
3385        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
3386
3387        * select: List --- Attributes of the new object to return in the response.
3388        """
3389
3390    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]':
3391        """Delete an existing VirtualMachine.
3392
3393        Required parameters:
3394
3395        * uuid: str --- The UUID of the VirtualMachine in question.
3396        """
3397
3398    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]':
3399        """Gets a VirtualMachine's metadata by UUID.
3400
3401        Required parameters:
3402
3403        * uuid: str --- The UUID of the VirtualMachine in question.
3404        """
3405
3406    def get_all_logins(self) -> 'ArvadosAPIRequest[VirtualMachine]':
3407        """get_all_logins virtual_machines"""
3408
3409    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[VirtualMachineList]':
3410        """List VirtualMachines.
3411
3412        Optional parameters:
3413
3414        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
3415
3416        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
3417
3418        * count: str --- Default 'exact'.
3419
3420        * distinct: bool --- Default False.
3421
3422        * filters: List
3423
3424        * limit: int --- Default 100.
3425
3426        * offset: int --- Default 0.
3427
3428        * order: List
3429
3430        * select: List --- Attributes of each object to return in the response.
3431
3432        * where: Dict[str, Any]
3433        """
3434
3435    def logins(self, *, uuid: 'str') -> 'ArvadosAPIRequest[VirtualMachine]':
3436        """logins virtual_machines
3437
3438        Required parameters:
3439
3440        * uuid: str
3441        """
3442
3443    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[VirtualMachine]':
3444        """Update attributes of an existing VirtualMachine.
3445
3446        Required parameters:
3447
3448        * uuid: str --- The UUID of the VirtualMachine in question.
3449
3450        Optional parameters:
3451
3452        * select: List --- Attributes of the updated object to return in the response.
3453        """
3454
3455
3456class Vocabularies:
3457    """Methods to query and manipulate Arvados vocabularies"""
3458
3459    def get(self) -> 'ArvadosAPIRequest[Dict[str, Any]]':
3460        """Get vocabulary definition"""
3461
3462
3463class Workflows:
3464    """Methods to query and manipulate Arvados workflows"""
3465
3466    def create(self, *, cluster_id: 'str', ensure_unique_name: 'bool', select: 'List') -> 'ArvadosAPIRequest[Workflow]':
3467        """Create a new Workflow.
3468
3469        Optional parameters:
3470
3471        * cluster_id: str --- Create object on a remote federated cluster instead of the current one.
3472
3473        * ensure_unique_name: bool --- Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision. Default False.
3474
3475        * select: List --- Attributes of the new object to return in the response.
3476        """
3477
3478    def delete(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Workflow]':
3479        """Delete an existing Workflow.
3480
3481        Required parameters:
3482
3483        * uuid: str --- The UUID of the Workflow in question.
3484        """
3485
3486    def get(self, *, uuid: 'str') -> 'ArvadosAPIRequest[Workflow]':
3487        """Gets a Workflow's metadata by UUID.
3488
3489        Required parameters:
3490
3491        * uuid: str --- The UUID of the Workflow in question.
3492        """
3493
3494    def list(self, *, bypass_federation: 'bool', cluster_id: 'str', count: 'str', distinct: 'bool', filters: 'List', limit: 'int', offset: 'int', order: 'List', select: 'List', where: 'Dict[str, Any]') -> 'ArvadosAPIRequest[WorkflowList]':
3495        """List Workflows.
3496
3497        Optional parameters:
3498
3499        * bypass_federation: bool --- bypass federation behavior, list items from local instance database only
3500
3501        * cluster_id: str --- List objects on a remote federated cluster instead of the current one.
3502
3503        * count: str --- Default 'exact'.
3504
3505        * distinct: bool --- Default False.
3506
3507        * filters: List
3508
3509        * limit: int --- Default 100.
3510
3511        * offset: int --- Default 0.
3512
3513        * order: List
3514
3515        * select: List --- Attributes of each object to return in the response.
3516
3517        * where: Dict[str, Any]
3518        """
3519
3520    def update(self, *, uuid: 'str', select: 'List') -> 'ArvadosAPIRequest[Workflow]':
3521        """Update attributes of an existing Workflow.
3522
3523        Required parameters:
3524
3525        * uuid: str --- The UUID of the Workflow in question.
3526
3527        Optional parameters:
3528
3529        * select: List --- Attributes of the updated object to return in the response.
3530        """
3531
3532
3533
3534class ArvadosAPIRequest(googleapiclient.http.HttpRequest, Generic[ST]):
3535    """Generic API request object
3536
3537    When you call an API method in the Arvados Python SDK, it returns a
3538    request object. You usually call `execute()` on this object to submit the
3539    request to your Arvados API server and retrieve the response. `execute()`
3540    will return the type of object annotated in the subscript of
3541    `ArvadosAPIRequest`.
3542    """
3543
3544    def execute(self, http: Optional[httplib2.Http]=None, num_retries: int=0) -> ST:
3545        """Execute this request and return the response
3546
3547        Arguments:
3548
3549        * http: httplib2.Http | None --- The HTTP client object to use to
3550          execute the request. If not specified, uses the HTTP client object
3551          created with the API client object.
3552
3553        * num_retries: int --- The maximum number of times to retry this
3554          request if the server returns a retryable failure. The API client
3555          object also has a maximum number of retries specified when it is
3556          instantiated (see `arvados.api.api_client`). This request is run
3557          with the larger of that number and this argument. Default 0.
3558        """
3559
3560
3561class ArvadosAPIClient(googleapiclient.discovery.Resource):
3562
3563    def api_client_authorizations(self) -> 'ApiClientAuthorizations':
3564        """Return an instance of `ApiClientAuthorizations` to call methods via this client"""
3565
3566
3567    def api_clients(self) -> 'ApiClients':
3568        """Return an instance of `ApiClients` to call methods via this client"""
3569
3570
3571    def authorized_keys(self) -> 'AuthorizedKeys':
3572        """Return an instance of `AuthorizedKeys` to call methods via this client"""
3573
3574
3575    def collections(self) -> 'Collections':
3576        """Return an instance of `Collections` to call methods via this client"""
3577
3578
3579    def configs(self) -> 'Configs':
3580        """Return an instance of `Configs` to call methods via this client"""
3581
3582
3583    def container_requests(self) -> 'ContainerRequests':
3584        """Return an instance of `ContainerRequests` to call methods via this client"""
3585
3586
3587    def containers(self) -> 'Containers':
3588        """Return an instance of `Containers` to call methods via this client"""
3589
3590
3591    def groups(self) -> 'Groups':
3592        """Return an instance of `Groups` to call methods via this client"""
3593
3594
3595    def humans(self) -> 'Humans':
3596        """Return an instance of `Humans` to call methods via this client
3597
3598        .. WARNING:: Deprecated
3599           This resource is deprecated in the Arvados API.
3600        """
3601
3602
3603    def job_tasks(self) -> 'JobTasks':
3604        """Return an instance of `JobTasks` to call methods via this client
3605
3606        .. WARNING:: Deprecated
3607           This resource is deprecated in the Arvados API.
3608        """
3609
3610
3611    def jobs(self) -> 'Jobs':
3612        """Return an instance of `Jobs` to call methods via this client
3613
3614        .. WARNING:: Deprecated
3615           This resource is deprecated in the Arvados API.
3616        """
3617
3618
3619    def keep_disks(self) -> 'KeepDisks':
3620        """Return an instance of `KeepDisks` to call methods via this client
3621
3622        .. WARNING:: Deprecated
3623           This resource is deprecated in the Arvados API.
3624        """
3625
3626
3627    def keep_services(self) -> 'KeepServices':
3628        """Return an instance of `KeepServices` to call methods via this client"""
3629
3630
3631    def links(self) -> 'Links':
3632        """Return an instance of `Links` to call methods via this client"""
3633
3634
3635    def logs(self) -> 'Logs':
3636        """Return an instance of `Logs` to call methods via this client"""
3637
3638
3639    def nodes(self) -> 'Nodes':
3640        """Return an instance of `Nodes` to call methods via this client
3641
3642        .. WARNING:: Deprecated
3643           This resource is deprecated in the Arvados API.
3644        """
3645
3646
3647    def pipeline_instances(self) -> 'PipelineInstances':
3648        """Return an instance of `PipelineInstances` to call methods via this client
3649
3650        .. WARNING:: Deprecated
3651           This resource is deprecated in the Arvados API.
3652        """
3653
3654
3655    def pipeline_templates(self) -> 'PipelineTemplates':
3656        """Return an instance of `PipelineTemplates` to call methods via this client
3657
3658        .. WARNING:: Deprecated
3659           This resource is deprecated in the Arvados API.
3660        """
3661
3662
3663    def repositories(self) -> 'Repositories':
3664        """Return an instance of `Repositories` to call methods via this client"""
3665
3666
3667    def specimens(self) -> 'Specimens':
3668        """Return an instance of `Specimens` to call methods via this client"""
3669
3670
3671    def sys(self) -> 'Sys':
3672        """Return an instance of `Sys` to call methods via this client"""
3673
3674
3675    def traits(self) -> 'Traits':
3676        """Return an instance of `Traits` to call methods via this client"""
3677
3678
3679    def user_agreements(self) -> 'UserAgreements':
3680        """Return an instance of `UserAgreements` to call methods via this client"""
3681
3682
3683    def users(self) -> 'Users':
3684        """Return an instance of `Users` to call methods via this client"""
3685
3686
3687    def virtual_machines(self) -> 'VirtualMachines':
3688        """Return an instance of `VirtualMachines` to call methods via this client"""
3689
3690
3691    def vocabularies(self) -> 'Vocabularies':
3692        """Return an instance of `Vocabularies` to call methods via this client"""
3693
3694
3695    def workflows(self) -> 'Workflows':
3696        """Return an instance of `Workflows` to call methods via this client"""