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