@maxim_mazurok/gapi.client.dataproc-v1 0.0.20230804 → 0.0.20230830

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +807 -8
  2. package/package.json +1 -1
  3. package/tests.ts +783 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://dataproc.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20230804
12
+ // Revision: 20230830
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -477,6 +477,9 @@ declare namespace gapi.client {
477
477
  /** Optional. Specifies a list of jobs on which diagnosis is to be performed. Format: projects/{project}/regions/{region}/jobs/{job} */
478
478
  jobs?:
479
479
  string[];
480
+ /** Optional. (Optional) The output Cloud Storage directory for the diagnostic tarball. If not specified, a task-specific directory in the cluster's staging bucket will be used. */
481
+ tarballGcsDir?:
482
+ string;
480
483
  /** Optional. DEPRECATED Specifies the yarn application on which diagnosis is to be performed. */
481
484
  yarnApplicationId?:
482
485
  string;
@@ -552,7 +555,7 @@ declare namespace gapi.client {
552
555
  /**
553
556
  * Optional. Applies to sessions only. The duration to keep the session alive while it's idling. Exceeding this threshold causes the session to terminate. This field cannot be set on a
554
557
  * batch workload. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
555
- * Defaults to 4 hours if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when
558
+ * Defaults to 1 hour if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when
556
559
  * it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
557
560
  */
558
561
  idleTtl?:
@@ -897,6 +900,14 @@ declare namespace gapi.client {
897
900
  credentialsCiphertext?:
898
901
  string;
899
902
  }
903
+ interface InstanceFlexibilityPolicy {
904
+ /** Optional. List of instance selection options that the group will use when creating new VMs. */
905
+ instanceSelectionList?:
906
+ InstanceSelection[];
907
+ /** Output only. A list of instance selection results in the group. */
908
+ instanceSelectionResults?:
909
+ InstanceSelectionResult[];
910
+ }
900
911
  interface InstanceGroupAutoscalingPolicyConfig {
901
912
  /**
902
913
  * Required. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if
@@ -933,6 +944,9 @@ declare namespace gapi.client {
933
944
  */
934
945
  imageUri?:
935
946
  string;
947
+ /** Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models. */
948
+ instanceFlexibilityPolicy?:
949
+ InstanceFlexibilityPolicy;
936
950
  /** Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group. */
937
951
  instanceNames?:
938
952
  string[];
@@ -957,12 +971,10 @@ declare namespace gapi.client {
957
971
  minCpuPlatform?:
958
972
  string;
959
973
  /**
960
- * Optional. The minimum number of instances to create. If min_num_instances is set, min_num_instances is used for a criteria to decide the cluster. Cluster creation will be failed by
961
- * being an error state if the total number of instances created is less than the min_num_instances. For example, given that num_instances = 5 and min_num_instances = 3, * if 4
962
- * instances are created and then registered successfully but one instance is failed, the failed VM will be deleted and the cluster will be resized to 4 instances in running state. *
963
- * if 2 instances are created successfully and 3 instances are failed, the cluster will be in an error state and does not delete failed VMs for debugging. * if 2 instance are created
964
- * and then registered successfully but 3 instances are failed to initialize, the cluster will be in an error state and does not delete failed VMs for debugging. NB: This can only be
965
- * set for primary workers now.
974
+ * Optional. The minimum number of primary worker instances to create. If min_num_instances is set, cluster creation will succeed if the number of primary workers created is at least
975
+ * equal to the min_num_instances number.Example: Cluster creation request with num_instances = 5 and min_num_instances = 3: If 4 VMs are created and 1 instance fails, the failed VM is
976
+ * deleted. The cluster is resized to 4 instances and placed in a RUNNING state. If 2 instances are created and 3 instances fail, the cluster in placed in an ERROR state. The failed
977
+ * VMs are not deleted.
966
978
  */
967
979
  minNumInstances?:
968
980
  number;
@@ -990,6 +1002,25 @@ declare namespace gapi.client {
990
1002
  publicKey?:
991
1003
  string;
992
1004
  }
1005
+ interface InstanceSelection {
1006
+ /** Optional. Full machine-type names, e.g. "n1-standard-16". */
1007
+ machineTypes?:
1008
+ string[];
1009
+ /**
1010
+ * Optional. Preference of this instance selection. Lower number means higher preference. Dataproc will first try to create a VM based on the machine-type with priority rank and
1011
+ * fallback to next rank based on availability. Machine types and instance selections with the same priority have the same preference.
1012
+ */
1013
+ rank?:
1014
+ number;
1015
+ }
1016
+ interface InstanceSelectionResult {
1017
+ /** Output only. Full machine-type names, e.g. "n1-standard-16". */
1018
+ machineType?:
1019
+ string;
1020
+ /** Output only. Number of VM provisioned with the machine_type. */
1021
+ vmCount?:
1022
+ number;
1023
+ }
993
1024
  interface InstantiateWorkflowTemplateRequest {
994
1025
  /** Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters. */
995
1026
  parameters?:
@@ -1162,6 +1193,14 @@ declare namespace gapi.client {
1162
1193
  substate?:
1163
1194
  string;
1164
1195
  }
1196
+ interface JupyterConfig {
1197
+ /** Optional. Display name, shown in the Jupyter kernelspec card. */
1198
+ displayName?:
1199
+ string;
1200
+ /** Optional. Kernel */
1201
+ kernel?:
1202
+ string;
1203
+ }
1165
1204
  interface KerberosConfig {
1166
1205
  /** Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship. */
1167
1206
  crossRealmTrustAdminServer?:
@@ -1315,6 +1354,22 @@ declare namespace gapi.client {
1315
1354
  operations?:
1316
1355
  Operation[];
1317
1356
  }
1357
+ interface ListSessionsResponse {
1358
+ /** A token, which can be sent as page_token, to retrieve the next page. If this field is omitted, there are no subsequent pages. */
1359
+ nextPageToken?:
1360
+ string;
1361
+ /** Output only. The sessions from the specified collection. */
1362
+ sessions?:
1363
+ Session[];
1364
+ }
1365
+ interface ListSessionTemplatesResponse {
1366
+ /** A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
1367
+ nextPageToken?:
1368
+ string;
1369
+ /** Output only. Session template list */
1370
+ sessionTemplates?:
1371
+ SessionTemplate[];
1372
+ }
1318
1373
  interface ListWorkflowTemplatesResponse {
1319
1374
  /**
1320
1375
  * Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent
@@ -1353,6 +1408,9 @@ declare namespace gapi.client {
1353
1408
  /** Output only. The name of the Instance Group Manager for this group. */
1354
1409
  instanceGroupManagerName?:
1355
1410
  string;
1411
+ /** Output only. The partial URI to the instance group manager for this group. E.g. projects/my-project/regions/us-central1/instanceGroupManagers/my-igm. */
1412
+ instanceGroupManagerUri?:
1413
+ string;
1356
1414
  /** Output only. The name of the Instance Template used for the Managed Instance Group. */
1357
1415
  instanceTemplateName?:
1358
1416
  string;
@@ -1640,6 +1698,11 @@ declare namespace gapi.client {
1640
1698
  queryList?:
1641
1699
  QueryList;
1642
1700
  }
1701
+ interface PyPiRepositoryConfig {
1702
+ /** Optional. PyPi repository address */
1703
+ pypiRepository?:
1704
+ string;
1705
+ }
1643
1706
  interface PySparkBatch {
1644
1707
  /** Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. */
1645
1708
  archiveUris?:
@@ -1733,6 +1796,11 @@ declare namespace gapi.client {
1733
1796
  requestId?:
1734
1797
  string;
1735
1798
  }
1799
+ interface RepositoryConfig {
1800
+ /** Optional. Configuration for PyPi repository. */
1801
+ pypiRepositoryConfig?:
1802
+ PyPiRepositoryConfig;
1803
+ }
1736
1804
  interface ReservationAffinity {
1737
1805
  /** Optional. Type of reservation to consume */
1738
1806
  consumeReservationType?:
@@ -1774,6 +1842,9 @@ declare namespace gapi.client {
1774
1842
  /** Optional. A mapping of property names to values, which are used to configure workload execution. */
1775
1843
  properties?:
1776
1844
  { [P in string]: string };
1845
+ /** Optional. Dependency repository configuration. */
1846
+ repositoryConfig?:
1847
+ RepositoryConfig;
1777
1848
  /** Optional. Version of the batch runtime. */
1778
1849
  version?:
1779
1850
  string;
@@ -1808,6 +1879,61 @@ declare namespace gapi.client {
1808
1879
  kerberosConfig?:
1809
1880
  KerberosConfig;
1810
1881
  }
1882
+ interface Session {
1883
+ /** Output only. The time when the session was created. */
1884
+ createTime?:
1885
+ string;
1886
+ /** Output only. The email address of the user who created the session. */
1887
+ creator?:
1888
+ string;
1889
+ /** Optional. Environment configuration for the session execution. */
1890
+ environmentConfig?:
1891
+ EnvironmentConfig;
1892
+ /** Optional. Jupyter session config. */
1893
+ jupyterSession?:
1894
+ JupyterConfig;
1895
+ /**
1896
+ * Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may
1897
+ * be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a
1898
+ * session.
1899
+ */
1900
+ labels?:
1901
+ { [P in string]: string };
1902
+ /** Required. The resource name of the session. */
1903
+ name?:
1904
+ string;
1905
+ /** Optional. Runtime configuration for the session execution. */
1906
+ runtimeConfig?:
1907
+ RuntimeConfig;
1908
+ /** Output only. Runtime information about session execution. */
1909
+ runtimeInfo?:
1910
+ RuntimeInfo;
1911
+ /**
1912
+ * Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: *
1913
+ * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] *
1914
+ * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session.
1915
+ */
1916
+ sessionTemplate?:
1917
+ string;
1918
+ /** Output only. A state of the session. */
1919
+ state?:
1920
+ string;
1921
+ /** Output only. Historical state information for the session. */
1922
+ stateHistory?:
1923
+ SessionStateHistory[];
1924
+ /** Output only. Session state details, such as the failure description if the state is FAILED. */
1925
+ stateMessage?:
1926
+ string;
1927
+ /** Output only. The time when the session entered the current state. */
1928
+ stateTime?:
1929
+ string;
1930
+ /** Optional. The email address of the user who owns the session. */
1931
+ user?:
1932
+ string;
1933
+ /** Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session. */
1934
+ uuid?:
1935
+ string;
1936
+ }
1811
1937
  interface SessionOperationMetadata {
1812
1938
  /** The time when the operation was created. */
1813
1939
  createTime?:
@@ -1834,6 +1960,50 @@ declare namespace gapi.client {
1834
1960
  warnings?:
1835
1961
  string[];
1836
1962
  }
1963
+ interface SessionStateHistory {
1964
+ /** Output only. The state of the session at this point in the session history. */
1965
+ state?:
1966
+ string;
1967
+ /** Output only. Details about the state at this point in the session history. */
1968
+ stateMessage?:
1969
+ string;
1970
+ /** Output only. The time when the session entered the historical state. */
1971
+ stateStartTime?:
1972
+ string;
1973
+ }
1974
+ interface SessionTemplate {
1975
+ /** Output only. The time when the template was created. */
1976
+ createTime?:
1977
+ string;
1978
+ /** Output only. The email address of the user who created the template. */
1979
+ creator?:
1980
+ string;
1981
+ /** Optional. Brief description of the template. */
1982
+ description?:
1983
+ string;
1984
+ /** Optional. Environment configuration for session execution. */
1985
+ environmentConfig?:
1986
+ EnvironmentConfig;
1987
+ /** Optional. Jupyter session config. */
1988
+ jupyterSession?:
1989
+ JupyterConfig;
1990
+ /**
1991
+ * Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035
1992
+ * (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).
1993
+ * No more than 32 labels can be associated with a session.
1994
+ */
1995
+ labels?:
1996
+ { [P in string]: string };
1997
+ /** Required. The resource name of the session template. */
1998
+ name?:
1999
+ string;
2000
+ /** Optional. Runtime configuration for session execution. */
2001
+ runtimeConfig?:
2002
+ RuntimeConfig;
2003
+ /** Output only. The time the template was last updated. */
2004
+ updateTime?:
2005
+ string;
2006
+ }
1837
2007
  interface SetIamPolicyRequest {
1838
2008
  /**
1839
2009
  * REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud
@@ -2133,6 +2303,16 @@ declare namespace gapi.client {
2133
2303
  validation?:
2134
2304
  ParameterValidation;
2135
2305
  }
2306
+ interface TerminateSessionRequest {
2307
+ /**
2308
+ * Optional. A unique ID used to identify the request. If the service receives two TerminateSessionRequest
2309
+ * (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.TerminateSessionRequest)s with the same ID, the second request is
2310
+ * ignored.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9),
2311
+ * underscores (_), and hyphens (-). The maximum length is 40 characters.
2312
+ */
2313
+ requestId?:
2314
+ string;
2315
+ }
2136
2316
  interface TestIamPermissionsRequest {
2137
2317
  /**
2138
2318
  * The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview
@@ -3227,6 +3407,621 @@ declare namespace gapi.client {
3227
3407
  string;
3228
3408
  }): Request<ListOperationsResponse>;
3229
3409
  }
3410
+ interface SessionsResource {
3411
+ /** Create an interactive session asynchronously. */
3412
+ create(request: {
3413
+ /** V1 error format. */
3414
+ "$.xgafv"?:
3415
+ string;
3416
+ /** OAuth access token. */
3417
+ access_token?:
3418
+ string;
3419
+ /** Data format for response. */
3420
+ alt?:
3421
+ string;
3422
+ /** JSONP */
3423
+ callback?:
3424
+ string;
3425
+ /** Selector specifying which fields to include in a partial response. */
3426
+ fields?:
3427
+ string;
3428
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3429
+ key?:
3430
+ string;
3431
+ /** OAuth 2.0 token for the current user. */
3432
+ oauth_token?:
3433
+ string;
3434
+ /** Required. The parent resource where this session will be created. */
3435
+ parent:
3436
+ string;
3437
+ /** Returns response with indentations and line breaks. */
3438
+ prettyPrint?:
3439
+ boolean;
3440
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3441
+ quotaUser?:
3442
+ string;
3443
+ /**
3444
+ * Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequests
3445
+ * (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateSessionRequest)s with the same ID, the second request is ignored,
3446
+ * and the first Session is created and stored in the backend.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must
3447
+ * contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
3448
+ */
3449
+ requestId?:
3450
+ string;
3451
+ /** Required. The ID to use for the session, which becomes the final component of the session's resource name.This value must be 4-63 characters. Valid characters are /a-z-/. */
3452
+ sessionId?:
3453
+ string;
3454
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3455
+ upload_protocol?:
3456
+ string;
3457
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3458
+ uploadType?:
3459
+ string;
3460
+ /** Request body */
3461
+ resource:
3462
+ Session;
3463
+ }): Request<Operation>;
3464
+ create(request: {
3465
+ /** V1 error format. */
3466
+ "$.xgafv"?:
3467
+ string;
3468
+ /** OAuth access token. */
3469
+ access_token?:
3470
+ string;
3471
+ /** Data format for response. */
3472
+ alt?:
3473
+ string;
3474
+ /** JSONP */
3475
+ callback?:
3476
+ string;
3477
+ /** Selector specifying which fields to include in a partial response. */
3478
+ fields?:
3479
+ string;
3480
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3481
+ key?:
3482
+ string;
3483
+ /** OAuth 2.0 token for the current user. */
3484
+ oauth_token?:
3485
+ string;
3486
+ /** Required. The parent resource where this session will be created. */
3487
+ parent:
3488
+ string;
3489
+ /** Returns response with indentations and line breaks. */
3490
+ prettyPrint?:
3491
+ boolean;
3492
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3493
+ quotaUser?:
3494
+ string;
3495
+ /**
3496
+ * Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequests
3497
+ * (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateSessionRequest)s with the same ID, the second request is ignored,
3498
+ * and the first Session is created and stored in the backend.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must
3499
+ * contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
3500
+ */
3501
+ requestId?:
3502
+ string;
3503
+ /** Required. The ID to use for the session, which becomes the final component of the session's resource name.This value must be 4-63 characters. Valid characters are /a-z-/. */
3504
+ sessionId?:
3505
+ string;
3506
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3507
+ upload_protocol?:
3508
+ string;
3509
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3510
+ uploadType?:
3511
+ string;
3512
+ },
3513
+ body: Session): Request<Operation>;
3514
+ /** Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted. */
3515
+ delete(request?: {
3516
+ /** V1 error format. */
3517
+ "$.xgafv"?:
3518
+ string;
3519
+ /** OAuth access token. */
3520
+ access_token?:
3521
+ string;
3522
+ /** Data format for response. */
3523
+ alt?:
3524
+ string;
3525
+ /** JSONP */
3526
+ callback?:
3527
+ string;
3528
+ /** Selector specifying which fields to include in a partial response. */
3529
+ fields?:
3530
+ string;
3531
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3532
+ key?:
3533
+ string;
3534
+ /** Required. The name of the session resource to delete. */
3535
+ name:
3536
+ string;
3537
+ /** OAuth 2.0 token for the current user. */
3538
+ oauth_token?:
3539
+ string;
3540
+ /** Returns response with indentations and line breaks. */
3541
+ prettyPrint?:
3542
+ boolean;
3543
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3544
+ quotaUser?:
3545
+ string;
3546
+ /**
3547
+ * Optional. A unique ID used to identify the request. If the service receives two DeleteSessionRequest
3548
+ * (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteSessionRequest)s with the same ID, the second request is
3549
+ * ignored.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9),
3550
+ * underscores (_), and hyphens (-). The maximum length is 40 characters.
3551
+ */
3552
+ requestId?:
3553
+ string;
3554
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3555
+ upload_protocol?:
3556
+ string;
3557
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3558
+ uploadType?:
3559
+ string;
3560
+ }): Request<Operation>;
3561
+ /** Gets the resource representation for an interactive session. */
3562
+ get(request?: {
3563
+ /** V1 error format. */
3564
+ "$.xgafv"?:
3565
+ string;
3566
+ /** OAuth access token. */
3567
+ access_token?:
3568
+ string;
3569
+ /** Data format for response. */
3570
+ alt?:
3571
+ string;
3572
+ /** JSONP */
3573
+ callback?:
3574
+ string;
3575
+ /** Selector specifying which fields to include in a partial response. */
3576
+ fields?:
3577
+ string;
3578
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3579
+ key?:
3580
+ string;
3581
+ /** Required. The name of the session to retrieve. */
3582
+ name:
3583
+ string;
3584
+ /** OAuth 2.0 token for the current user. */
3585
+ oauth_token?:
3586
+ string;
3587
+ /** Returns response with indentations and line breaks. */
3588
+ prettyPrint?:
3589
+ boolean;
3590
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3591
+ quotaUser?:
3592
+ string;
3593
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3594
+ upload_protocol?:
3595
+ string;
3596
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3597
+ uploadType?:
3598
+ string;
3599
+ }): Request<Session>;
3600
+ /** Lists interactive sessions. */
3601
+ list(request?: {
3602
+ /** V1 error format. */
3603
+ "$.xgafv"?:
3604
+ string;
3605
+ /** OAuth access token. */
3606
+ access_token?:
3607
+ string;
3608
+ /** Data format for response. */
3609
+ alt?:
3610
+ string;
3611
+ /** JSONP */
3612
+ callback?:
3613
+ string;
3614
+ /** Selector specifying which fields to include in a partial response. */
3615
+ fields?:
3616
+ string;
3617
+ /**
3618
+ * Optional. A filter for the sessions to return in the response.A filter is a logical expression constraining the values of various fields in each session resource. Filters are
3619
+ * case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields are session_id, session_uuid, state, and create_time.Example: state
3620
+ * = ACTIVE and create_time < "2023-01-01T00:00:00Z" is a filter for sessions in an ACTIVE state that were created before 2023-01-01.See
3621
+ * https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparators.
3622
+ */
3623
+ filter?:
3624
+ string;
3625
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3626
+ key?:
3627
+ string;
3628
+ /** OAuth 2.0 token for the current user. */
3629
+ oauth_token?:
3630
+ string;
3631
+ /** Optional. The maximum number of sessions to return in each response. The service may return fewer than this value. */
3632
+ pageSize?:
3633
+ number;
3634
+ /** Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page. */
3635
+ pageToken?:
3636
+ string;
3637
+ /** Required. The parent, which owns this collection of sessions. */
3638
+ parent:
3639
+ string;
3640
+ /** Returns response with indentations and line breaks. */
3641
+ prettyPrint?:
3642
+ boolean;
3643
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3644
+ quotaUser?:
3645
+ string;
3646
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3647
+ upload_protocol?:
3648
+ string;
3649
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3650
+ uploadType?:
3651
+ string;
3652
+ }): Request<ListSessionsResponse>;
3653
+ /** Terminates the interactive session. */
3654
+ terminate(request: {
3655
+ /** V1 error format. */
3656
+ "$.xgafv"?:
3657
+ string;
3658
+ /** OAuth access token. */
3659
+ access_token?:
3660
+ string;
3661
+ /** Data format for response. */
3662
+ alt?:
3663
+ string;
3664
+ /** JSONP */
3665
+ callback?:
3666
+ string;
3667
+ /** Selector specifying which fields to include in a partial response. */
3668
+ fields?:
3669
+ string;
3670
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3671
+ key?:
3672
+ string;
3673
+ /** Required. The name of the session resource to terminate. */
3674
+ name:
3675
+ string;
3676
+ /** OAuth 2.0 token for the current user. */
3677
+ oauth_token?:
3678
+ string;
3679
+ /** Returns response with indentations and line breaks. */
3680
+ prettyPrint?:
3681
+ boolean;
3682
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3683
+ quotaUser?:
3684
+ string;
3685
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3686
+ upload_protocol?:
3687
+ string;
3688
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3689
+ uploadType?:
3690
+ string;
3691
+ /** Request body */
3692
+ resource:
3693
+ TerminateSessionRequest;
3694
+ }): Request<Operation>;
3695
+ terminate(request: {
3696
+ /** V1 error format. */
3697
+ "$.xgafv"?:
3698
+ string;
3699
+ /** OAuth access token. */
3700
+ access_token?:
3701
+ string;
3702
+ /** Data format for response. */
3703
+ alt?:
3704
+ string;
3705
+ /** JSONP */
3706
+ callback?:
3707
+ string;
3708
+ /** Selector specifying which fields to include in a partial response. */
3709
+ fields?:
3710
+ string;
3711
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3712
+ key?:
3713
+ string;
3714
+ /** Required. The name of the session resource to terminate. */
3715
+ name:
3716
+ string;
3717
+ /** OAuth 2.0 token for the current user. */
3718
+ oauth_token?:
3719
+ string;
3720
+ /** Returns response with indentations and line breaks. */
3721
+ prettyPrint?:
3722
+ boolean;
3723
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3724
+ quotaUser?:
3725
+ string;
3726
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3727
+ upload_protocol?:
3728
+ string;
3729
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3730
+ uploadType?:
3731
+ string;
3732
+ },
3733
+ body: TerminateSessionRequest): Request<Operation>;
3734
+ }
3735
+ interface SessionTemplatesResource {
3736
+ /** Create a session template synchronously. */
3737
+ create(request: {
3738
+ /** V1 error format. */
3739
+ "$.xgafv"?:
3740
+ string;
3741
+ /** OAuth access token. */
3742
+ access_token?:
3743
+ string;
3744
+ /** Data format for response. */
3745
+ alt?:
3746
+ string;
3747
+ /** JSONP */
3748
+ callback?:
3749
+ string;
3750
+ /** Selector specifying which fields to include in a partial response. */
3751
+ fields?:
3752
+ string;
3753
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3754
+ key?:
3755
+ string;
3756
+ /** OAuth 2.0 token for the current user. */
3757
+ oauth_token?:
3758
+ string;
3759
+ /** Required. The parent resource where this session template will be created. */
3760
+ parent:
3761
+ string;
3762
+ /** Returns response with indentations and line breaks. */
3763
+ prettyPrint?:
3764
+ boolean;
3765
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3766
+ quotaUser?:
3767
+ string;
3768
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3769
+ upload_protocol?:
3770
+ string;
3771
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3772
+ uploadType?:
3773
+ string;
3774
+ /** Request body */
3775
+ resource:
3776
+ SessionTemplate;
3777
+ }): Request<SessionTemplate>;
3778
+ create(request: {
3779
+ /** V1 error format. */
3780
+ "$.xgafv"?:
3781
+ string;
3782
+ /** OAuth access token. */
3783
+ access_token?:
3784
+ string;
3785
+ /** Data format for response. */
3786
+ alt?:
3787
+ string;
3788
+ /** JSONP */
3789
+ callback?:
3790
+ string;
3791
+ /** Selector specifying which fields to include in a partial response. */
3792
+ fields?:
3793
+ string;
3794
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3795
+ key?:
3796
+ string;
3797
+ /** OAuth 2.0 token for the current user. */
3798
+ oauth_token?:
3799
+ string;
3800
+ /** Required. The parent resource where this session template will be created. */
3801
+ parent:
3802
+ string;
3803
+ /** Returns response with indentations and line breaks. */
3804
+ prettyPrint?:
3805
+ boolean;
3806
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3807
+ quotaUser?:
3808
+ string;
3809
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3810
+ upload_protocol?:
3811
+ string;
3812
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3813
+ uploadType?:
3814
+ string;
3815
+ },
3816
+ body: SessionTemplate): Request<SessionTemplate>;
3817
+ /** Deletes a session template. */
3818
+ delete(request?: {
3819
+ /** V1 error format. */
3820
+ "$.xgafv"?:
3821
+ string;
3822
+ /** OAuth access token. */
3823
+ access_token?:
3824
+ string;
3825
+ /** Data format for response. */
3826
+ alt?:
3827
+ string;
3828
+ /** JSONP */
3829
+ callback?:
3830
+ string;
3831
+ /** Selector specifying which fields to include in a partial response. */
3832
+ fields?:
3833
+ string;
3834
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3835
+ key?:
3836
+ string;
3837
+ /** Required. The name of the session template resource to delete. */
3838
+ name:
3839
+ string;
3840
+ /** OAuth 2.0 token for the current user. */
3841
+ oauth_token?:
3842
+ string;
3843
+ /** Returns response with indentations and line breaks. */
3844
+ prettyPrint?:
3845
+ boolean;
3846
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3847
+ quotaUser?:
3848
+ string;
3849
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3850
+ upload_protocol?:
3851
+ string;
3852
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3853
+ uploadType?:
3854
+ string;
3855
+ }): Request<{}>;
3856
+ /** Gets the resource representation for a session template. */
3857
+ get(request?: {
3858
+ /** V1 error format. */
3859
+ "$.xgafv"?:
3860
+ string;
3861
+ /** OAuth access token. */
3862
+ access_token?:
3863
+ string;
3864
+ /** Data format for response. */
3865
+ alt?:
3866
+ string;
3867
+ /** JSONP */
3868
+ callback?:
3869
+ string;
3870
+ /** Selector specifying which fields to include in a partial response. */
3871
+ fields?:
3872
+ string;
3873
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3874
+ key?:
3875
+ string;
3876
+ /** Required. The name of the session template to retrieve. */
3877
+ name:
3878
+ string;
3879
+ /** OAuth 2.0 token for the current user. */
3880
+ oauth_token?:
3881
+ string;
3882
+ /** Returns response with indentations and line breaks. */
3883
+ prettyPrint?:
3884
+ boolean;
3885
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3886
+ quotaUser?:
3887
+ string;
3888
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3889
+ upload_protocol?:
3890
+ string;
3891
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3892
+ uploadType?:
3893
+ string;
3894
+ }): Request<SessionTemplate>;
3895
+ /** Lists session templates. */
3896
+ list(request?: {
3897
+ /** V1 error format. */
3898
+ "$.xgafv"?:
3899
+ string;
3900
+ /** OAuth access token. */
3901
+ access_token?:
3902
+ string;
3903
+ /** Data format for response. */
3904
+ alt?:
3905
+ string;
3906
+ /** JSONP */
3907
+ callback?:
3908
+ string;
3909
+ /** Selector specifying which fields to include in a partial response. */
3910
+ fields?:
3911
+ string;
3912
+ /** Optional. A filter for the session templates to return in the response. Filters are case sensitive and have the following syntax:field = value AND field = value ... */
3913
+ filter?:
3914
+ string;
3915
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3916
+ key?:
3917
+ string;
3918
+ /** OAuth 2.0 token for the current user. */
3919
+ oauth_token?:
3920
+ string;
3921
+ /** Optional. The maximum number of sessions to return in each response. The service may return fewer than this value. */
3922
+ pageSize?:
3923
+ number;
3924
+ /** Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page. */
3925
+ pageToken?:
3926
+ string;
3927
+ /** Required. The parent that owns this collection of session templates. */
3928
+ parent:
3929
+ string;
3930
+ /** Returns response with indentations and line breaks. */
3931
+ prettyPrint?:
3932
+ boolean;
3933
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3934
+ quotaUser?:
3935
+ string;
3936
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3937
+ upload_protocol?:
3938
+ string;
3939
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3940
+ uploadType?:
3941
+ string;
3942
+ }): Request<ListSessionTemplatesResponse>;
3943
+ /** Updates the session template synchronously. */
3944
+ patch(request: {
3945
+ /** V1 error format. */
3946
+ "$.xgafv"?:
3947
+ string;
3948
+ /** OAuth access token. */
3949
+ access_token?:
3950
+ string;
3951
+ /** Data format for response. */
3952
+ alt?:
3953
+ string;
3954
+ /** JSONP */
3955
+ callback?:
3956
+ string;
3957
+ /** Selector specifying which fields to include in a partial response. */
3958
+ fields?:
3959
+ string;
3960
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3961
+ key?:
3962
+ string;
3963
+ /** Required. The resource name of the session template. */
3964
+ name:
3965
+ string;
3966
+ /** OAuth 2.0 token for the current user. */
3967
+ oauth_token?:
3968
+ string;
3969
+ /** Returns response with indentations and line breaks. */
3970
+ prettyPrint?:
3971
+ boolean;
3972
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3973
+ quotaUser?:
3974
+ string;
3975
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3976
+ upload_protocol?:
3977
+ string;
3978
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3979
+ uploadType?:
3980
+ string;
3981
+ /** Request body */
3982
+ resource:
3983
+ SessionTemplate;
3984
+ }): Request<SessionTemplate>;
3985
+ patch(request: {
3986
+ /** V1 error format. */
3987
+ "$.xgafv"?:
3988
+ string;
3989
+ /** OAuth access token. */
3990
+ access_token?:
3991
+ string;
3992
+ /** Data format for response. */
3993
+ alt?:
3994
+ string;
3995
+ /** JSONP */
3996
+ callback?:
3997
+ string;
3998
+ /** Selector specifying which fields to include in a partial response. */
3999
+ fields?:
4000
+ string;
4001
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
4002
+ key?:
4003
+ string;
4004
+ /** Required. The resource name of the session template. */
4005
+ name:
4006
+ string;
4007
+ /** OAuth 2.0 token for the current user. */
4008
+ oauth_token?:
4009
+ string;
4010
+ /** Returns response with indentations and line breaks. */
4011
+ prettyPrint?:
4012
+ boolean;
4013
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
4014
+ quotaUser?:
4015
+ string;
4016
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4017
+ upload_protocol?:
4018
+ string;
4019
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4020
+ uploadType?:
4021
+ string;
4022
+ },
4023
+ body: SessionTemplate): Request<SessionTemplate>;
4024
+ }
3230
4025
  interface WorkflowTemplatesResource {
3231
4026
  /** Creates new workflow template. */
3232
4027
  create(request: {
@@ -3893,6 +4688,10 @@ declare namespace gapi.client {
3893
4688
  BatchesResource;
3894
4689
  operations:
3895
4690
  OperationsResource;
4691
+ sessions:
4692
+ SessionsResource;
4693
+ sessionTemplates:
4694
+ SessionTemplatesResource;
3896
4695
  workflowTemplates:
3897
4696
  WorkflowTemplatesResource;
3898
4697
  }