@maxim_mazurok/gapi.client.dataproc-v1 0.0.20230726 → 0.0.20230814

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 +998 -132
  2. package/package.json +2 -2
  3. package/tests.ts +242 -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: 20230726
12
+ // Revision: 20230814
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -552,7 +552,7 @@ declare namespace gapi.client {
552
552
  /**
553
553
  * 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
554
  * 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
555
+ * 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
556
  * it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
557
557
  */
558
558
  idleTtl?:
@@ -897,6 +897,22 @@ declare namespace gapi.client {
897
897
  credentialsCiphertext?:
898
898
  string;
899
899
  }
900
+ interface InjectSessionCredentialsRequest {
901
+ /**
902
+ * Required. The encrypted credentials being injected in to the session.The client is responsible for encrypting the credentials in a way that is supported by the session.A wrapped
903
+ * value is used here so that the actual contents of the encrypted credentials are not written to audit logs.
904
+ */
905
+ credentialsCiphertext?:
906
+ string;
907
+ /**
908
+ * Optional. A unique ID used to identify the request. If the service receives two TerminateSessionRequest
909
+ * (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.TerminateSessionRequest)s with the same ID, the first request is ignored to
910
+ * ensure the most recent credentials are injected.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only
911
+ * letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
912
+ */
913
+ requestId?:
914
+ string;
915
+ }
900
916
  interface InstanceGroupAutoscalingPolicyConfig {
901
917
  /**
902
918
  * 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
@@ -956,6 +972,16 @@ declare namespace gapi.client {
956
972
  /** Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu). */
957
973
  minCpuPlatform?:
958
974
  string;
975
+ /**
976
+ * 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
977
+ * 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
978
+ * 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. *
979
+ * 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
980
+ * 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
981
+ * set for primary workers now.
982
+ */
983
+ minNumInstances?:
984
+ number;
959
985
  /** Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1. */
960
986
  numInstances?:
961
987
  number;
@@ -1152,6 +1178,14 @@ declare namespace gapi.client {
1152
1178
  substate?:
1153
1179
  string;
1154
1180
  }
1181
+ interface JupyterConfig {
1182
+ /** Optional. Display name, shown in the Jupyter kernelspec card. */
1183
+ displayName?:
1184
+ string;
1185
+ /** Optional. Kernel */
1186
+ kernel?:
1187
+ string;
1188
+ }
1155
1189
  interface KerberosConfig {
1156
1190
  /** Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship. */
1157
1191
  crossRealmTrustAdminServer?:
@@ -1305,6 +1339,22 @@ declare namespace gapi.client {
1305
1339
  operations?:
1306
1340
  Operation[];
1307
1341
  }
1342
+ interface ListSessionsResponse {
1343
+ /** A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
1344
+ nextPageToken?:
1345
+ string;
1346
+ /** Output only. The sessions from the specified collection. */
1347
+ sessions?:
1348
+ Session[];
1349
+ }
1350
+ interface ListSessionTemplatesResponse {
1351
+ /** A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
1352
+ nextPageToken?:
1353
+ string;
1354
+ /** Output only. Session template list */
1355
+ sessionTemplates?:
1356
+ SessionTemplate[];
1357
+ }
1308
1358
  interface ListWorkflowTemplatesResponse {
1309
1359
  /**
1310
1360
  * 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
@@ -1477,9 +1527,9 @@ declare namespace gapi.client {
1477
1527
  name?:
1478
1528
  string;
1479
1529
  /**
1480
- * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original
1481
- * method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name.
1482
- * For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
1530
+ * The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is
1531
+ * standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For
1532
+ * example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
1483
1533
  */
1484
1534
  response?:
1485
1535
  { [P in string]: any };
@@ -1798,6 +1848,61 @@ declare namespace gapi.client {
1798
1848
  kerberosConfig?:
1799
1849
  KerberosConfig;
1800
1850
  }
1851
+ interface Session {
1852
+ /** Output only. The time when the session was created. */
1853
+ createTime?:
1854
+ string;
1855
+ /** Output only. The email address of the user who created the session. */
1856
+ creator?:
1857
+ string;
1858
+ /** Optional. Environment configuration for the session execution. */
1859
+ environmentConfig?:
1860
+ EnvironmentConfig;
1861
+ /** Optional. Jupyter session config. */
1862
+ jupyterSession?:
1863
+ JupyterConfig;
1864
+ /**
1865
+ * Optional. The labels to associate with this session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values
1866
+ * may 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
1867
+ * session.
1868
+ */
1869
+ labels?:
1870
+ { [P in string]: string };
1871
+ /** Required. The resource name of the session. */
1872
+ name?:
1873
+ string;
1874
+ /** Optional. Runtime configuration for the session execution. */
1875
+ runtimeConfig?:
1876
+ RuntimeConfig;
1877
+ /** Output only. Runtime information about session execution. */
1878
+ runtimeInfo?:
1879
+ RuntimeInfo;
1880
+ /**
1881
+ * Optional. The session template used by the session.Only resource names including project ID and location are valid.Example: *
1882
+ * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] *
1883
+ * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]Note that the template must be in the same project and Dataproc region.
1884
+ */
1885
+ sessionTemplate?:
1886
+ string;
1887
+ /** Output only. A state of the session. */
1888
+ state?:
1889
+ string;
1890
+ /** Output only. Historical state information for the session. */
1891
+ stateHistory?:
1892
+ SessionStateHistory[];
1893
+ /** Output only. Session state details, such as a failure description if the state is FAILED. */
1894
+ stateMessage?:
1895
+ string;
1896
+ /** Output only. The time when the session entered a current state. */
1897
+ stateTime?:
1898
+ string;
1899
+ /** Optional. The email address of the user who owns the session. */
1900
+ user?:
1901
+ string;
1902
+ /** Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session. */
1903
+ uuid?:
1904
+ string;
1905
+ }
1801
1906
  interface SessionOperationMetadata {
1802
1907
  /** The time when the operation was created. */
1803
1908
  createTime?:
@@ -1824,6 +1929,50 @@ declare namespace gapi.client {
1824
1929
  warnings?:
1825
1930
  string[];
1826
1931
  }
1932
+ interface SessionStateHistory {
1933
+ /** Output only. The state of the session at this point in history. */
1934
+ state?:
1935
+ string;
1936
+ /** Output only. Details about the state at this point in history. */
1937
+ stateMessage?:
1938
+ string;
1939
+ /** Output only. The time when the session entered the historical state. */
1940
+ stateStartTime?:
1941
+ string;
1942
+ }
1943
+ interface SessionTemplate {
1944
+ /** Output only. The time when the template was created. */
1945
+ createTime?:
1946
+ string;
1947
+ /** Output only. The email address of the user who created the template. */
1948
+ creator?:
1949
+ string;
1950
+ /** Optional. Brief description of the template. */
1951
+ description?:
1952
+ string;
1953
+ /** Optional. Environment configuration for session execution. */
1954
+ environmentConfig?:
1955
+ EnvironmentConfig;
1956
+ /** Optional. Jupyter session config. */
1957
+ jupyterSession?:
1958
+ JupyterConfig;
1959
+ /**
1960
+ * Optional. The labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035
1961
+ * (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035
1962
+ * (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
1963
+ */
1964
+ labels?:
1965
+ { [P in string]: string };
1966
+ /** Required. The resource name of the session template. */
1967
+ name?:
1968
+ string;
1969
+ /** Optional. Runtime configuration for session execution. */
1970
+ runtimeConfig?:
1971
+ RuntimeConfig;
1972
+ /** Output only. The time template was last updated. */
1973
+ updateTime?:
1974
+ string;
1975
+ }
1827
1976
  interface SetIamPolicyRequest {
1828
1977
  /**
1829
1978
  * 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
@@ -2123,6 +2272,16 @@ declare namespace gapi.client {
2123
2272
  validation?:
2124
2273
  ParameterValidation;
2125
2274
  }
2275
+ interface TerminateSessionRequest {
2276
+ /**
2277
+ * Optional. A unique ID used to identify the request. If the service receives two TerminateSessionRequest
2278
+ * (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
2279
+ * 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),
2280
+ * underscores (_), and hyphens (-). The maximum length is 40 characters.
2281
+ */
2282
+ requestId?:
2283
+ string;
2284
+ }
2126
2285
  interface TestIamPermissionsRequest {
2127
2286
  /**
2128
2287
  * 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
@@ -3217,8 +3376,8 @@ declare namespace gapi.client {
3217
3376
  string;
3218
3377
  }): Request<ListOperationsResponse>;
3219
3378
  }
3220
- interface WorkflowTemplatesResource {
3221
- /** Creates new workflow template. */
3379
+ interface SessionsResource {
3380
+ /** Create an interactive session asynchronously. */
3222
3381
  create(request: {
3223
3382
  /** V1 error format. */
3224
3383
  "$.xgafv"?:
@@ -3241,11 +3400,7 @@ declare namespace gapi.client {
3241
3400
  /** OAuth 2.0 token for the current user. */
3242
3401
  oauth_token?:
3243
3402
  string;
3244
- /**
3245
- * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.create, the
3246
- * resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location
3247
- * has the following format: projects/{project_id}/locations/{location}
3248
- */
3403
+ /** Required. The parent resource where this session will be created. */
3249
3404
  parent:
3250
3405
  string;
3251
3406
  /** Returns response with indentations and line breaks. */
@@ -3254,6 +3409,17 @@ declare namespace gapi.client {
3254
3409
  /** 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. */
3255
3410
  quotaUser?:
3256
3411
  string;
3412
+ /**
3413
+ * Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequest
3414
+ * (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
3415
+ * and the first Session is created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The
3416
+ * value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
3417
+ */
3418
+ requestId?:
3419
+ string;
3420
+ /** 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-/. */
3421
+ sessionId?:
3422
+ string;
3257
3423
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3258
3424
  upload_protocol?:
3259
3425
  string;
@@ -3262,8 +3428,8 @@ declare namespace gapi.client {
3262
3428
  string;
3263
3429
  /** Request body */
3264
3430
  resource:
3265
- WorkflowTemplate;
3266
- }): Request<WorkflowTemplate>;
3431
+ Session;
3432
+ }): Request<Operation>;
3267
3433
  create(request: {
3268
3434
  /** V1 error format. */
3269
3435
  "$.xgafv"?:
@@ -3286,11 +3452,7 @@ declare namespace gapi.client {
3286
3452
  /** OAuth 2.0 token for the current user. */
3287
3453
  oauth_token?:
3288
3454
  string;
3289
- /**
3290
- * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.create, the
3291
- * resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location
3292
- * has the following format: projects/{project_id}/locations/{location}
3293
- */
3455
+ /** Required. The parent resource where this session will be created. */
3294
3456
  parent:
3295
3457
  string;
3296
3458
  /** Returns response with indentations and line breaks. */
@@ -3299,6 +3461,17 @@ declare namespace gapi.client {
3299
3461
  /** 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. */
3300
3462
  quotaUser?:
3301
3463
  string;
3464
+ /**
3465
+ * Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequest
3466
+ * (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
3467
+ * and the first Session is created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The
3468
+ * value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
3469
+ */
3470
+ requestId?:
3471
+ string;
3472
+ /** 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-/. */
3473
+ sessionId?:
3474
+ string;
3302
3475
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3303
3476
  upload_protocol?:
3304
3477
  string;
@@ -3306,8 +3479,8 @@ declare namespace gapi.client {
3306
3479
  uploadType?:
3307
3480
  string;
3308
3481
  },
3309
- body: WorkflowTemplate): Request<WorkflowTemplate>;
3310
- /** Deletes a workflow template. It does not cancel in-progress workflows. */
3482
+ body: Session): Request<Operation>;
3483
+ /** Deletes the interactive session resource. If the session is not in terminal state, it will be terminated and deleted afterwards. */
3311
3484
  delete(request?: {
3312
3485
  /** V1 error format. */
3313
3486
  "$.xgafv"?:
@@ -3327,12 +3500,7 @@ declare namespace gapi.client {
3327
3500
  /** 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. */
3328
3501
  key?:
3329
3502
  string;
3330
- /**
3331
- * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the
3332
- * resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
3333
- * projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format:
3334
- * projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
3335
- */
3503
+ /** Required. The name of the session resource to delete. */
3336
3504
  name:
3337
3505
  string;
3338
3506
  /** OAuth 2.0 token for the current user. */
@@ -3344,17 +3512,22 @@ declare namespace gapi.client {
3344
3512
  /** 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. */
3345
3513
  quotaUser?:
3346
3514
  string;
3515
+ /**
3516
+ * Optional. A unique ID used to identify the request. If the service receives two DeleteSessionRequest
3517
+ * (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
3518
+ * 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),
3519
+ * underscores (_), and hyphens (-). The maximum length is 40 characters.
3520
+ */
3521
+ requestId?:
3522
+ string;
3347
3523
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3348
3524
  upload_protocol?:
3349
3525
  string;
3350
3526
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3351
3527
  uploadType?:
3352
3528
  string;
3353
- /** Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version. */
3354
- version?:
3355
- number;
3356
- }): Request<{}>;
3357
- /** Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. */
3529
+ }): Request<Operation>;
3530
+ /** Gets the resource representation for an interactive session. */
3358
3531
  get(request?: {
3359
3532
  /** V1 error format. */
3360
3533
  "$.xgafv"?:
@@ -3374,11 +3547,7 @@ declare namespace gapi.client {
3374
3547
  /** 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. */
3375
3548
  key?:
3376
3549
  string;
3377
- /**
3378
- * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the
3379
- * resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the
3380
- * resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
3381
- */
3550
+ /** Required. The name of the session to retrieve. */
3382
3551
  name:
3383
3552
  string;
3384
3553
  /** OAuth 2.0 token for the current user. */
@@ -3396,12 +3565,9 @@ declare namespace gapi.client {
3396
3565
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3397
3566
  uploadType?:
3398
3567
  string;
3399
- /** Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version. */
3400
- version?:
3401
- number;
3402
- }): Request<WorkflowTemplate>;
3403
- /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
3404
- getIamPolicy(request: {
3568
+ }): Request<Session>;
3569
+ /** Inject Credentials in the interactive session. */
3570
+ injectCredentials(request: {
3405
3571
  /** V1 error format. */
3406
3572
  "$.xgafv"?:
3407
3573
  string;
@@ -3429,11 +3595,8 @@ declare namespace gapi.client {
3429
3595
  /** 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. */
3430
3596
  quotaUser?:
3431
3597
  string;
3432
- /**
3433
- * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
3434
- * field.
3435
- */
3436
- resource:
3598
+ /** Required. The name of the session resource to inject credentials to. */
3599
+ session:
3437
3600
  string;
3438
3601
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3439
3602
  upload_protocol?:
@@ -3441,15 +3604,11 @@ declare namespace gapi.client {
3441
3604
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3442
3605
  uploadType?:
3443
3606
  string;
3444
- },
3445
- body: GetIamPolicyRequest): Request<Policy>;
3446
- /**
3447
- * Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire
3448
- * workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The
3449
- * Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata
3450
- * (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.
3451
- */
3452
- instantiate(request: {
3607
+ /** Request body */
3608
+ resource:
3609
+ InjectSessionCredentialsRequest;
3610
+ }): Request<Operation>;
3611
+ injectCredentials(request: {
3453
3612
  /** V1 error format. */
3454
3613
  "$.xgafv"?:
3455
3614
  string;
@@ -3468,14 +3627,6 @@ declare namespace gapi.client {
3468
3627
  /** 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. */
3469
3628
  key?:
3470
3629
  string;
3471
- /**
3472
- * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate,
3473
- * the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
3474
- * projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format:
3475
- * projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
3476
- */
3477
- name:
3478
- string;
3479
3630
  /** OAuth 2.0 token for the current user. */
3480
3631
  oauth_token?:
3481
3632
  string;
@@ -3485,17 +3636,19 @@ declare namespace gapi.client {
3485
3636
  /** 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. */
3486
3637
  quotaUser?:
3487
3638
  string;
3639
+ /** Required. The name of the session resource to inject credentials to. */
3640
+ session:
3641
+ string;
3488
3642
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3489
3643
  upload_protocol?:
3490
3644
  string;
3491
3645
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3492
3646
  uploadType?:
3493
3647
  string;
3494
- /** Request body */
3495
- resource:
3496
- InstantiateWorkflowTemplateRequest;
3497
- }): Request<Operation>;
3498
- instantiate(request: {
3648
+ },
3649
+ body: InjectSessionCredentialsRequest): Request<Operation>;
3650
+ /** Lists interactive sessions. */
3651
+ list(request?: {
3499
3652
  /** V1 error format. */
3500
3653
  "$.xgafv"?:
3501
3654
  string;
@@ -3511,20 +3664,29 @@ declare namespace gapi.client {
3511
3664
  /** Selector specifying which fields to include in a partial response. */
3512
3665
  fields?:
3513
3666
  string;
3514
- /** 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. */
3515
- key?:
3516
- string;
3517
3667
  /**
3518
- * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate,
3519
- * the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
3520
- * projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format:
3521
- * projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
3668
+ * 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
3669
+ * case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are session_id, session_uuid, state, and create_time.e.g. state =
3670
+ * ACTIVE and create_time < "2023-01-01T00:00:00Z" filters for sessions in state ACTIVE that were created before 2023-01-01See https://google.aip.dev/assets/misc/ebnf-filtering.txt
3671
+ * for a detailed description of the filter syntax and a list of supported comparisons.
3522
3672
  */
3523
- name:
3673
+ filter?:
3674
+ string;
3675
+ /** 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. */
3676
+ key?:
3524
3677
  string;
3525
3678
  /** OAuth 2.0 token for the current user. */
3526
3679
  oauth_token?:
3527
3680
  string;
3681
+ /** Optional. The maximum number of sessions to return in each response. The service may return fewer than this value. */
3682
+ pageSize?:
3683
+ number;
3684
+ /** Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page. */
3685
+ pageToken?:
3686
+ string;
3687
+ /** Required. The parent, which owns this collection of sessions. */
3688
+ parent:
3689
+ string;
3528
3690
  /** Returns response with indentations and line breaks. */
3529
3691
  prettyPrint?:
3530
3692
  boolean;
@@ -3537,16 +3699,9 @@ declare namespace gapi.client {
3537
3699
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3538
3700
  uploadType?:
3539
3701
  string;
3540
- },
3541
- body: InstantiateWorkflowTemplateRequest): Request<Operation>;
3542
- /**
3543
- * Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The
3544
- * returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be
3545
- * aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata
3546
- * (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata
3547
- * (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.
3548
- */
3549
- instantiateInline(request: {
3702
+ }): Request<ListSessionsResponse>;
3703
+ /** Terminates the interactive session. */
3704
+ terminate(request: {
3550
3705
  /** V1 error format. */
3551
3706
  "$.xgafv"?:
3552
3707
  string;
@@ -3565,29 +3720,18 @@ declare namespace gapi.client {
3565
3720
  /** 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. */
3566
3721
  key?:
3567
3722
  string;
3723
+ /** Required. The name of the session resource to terminate. */
3724
+ name:
3725
+ string;
3568
3726
  /** OAuth 2.0 token for the current user. */
3569
3727
  oauth_token?:
3570
3728
  string;
3571
- /**
3572
- * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For
3573
- * projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For
3574
- * projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}
3575
- */
3576
- parent:
3577
- string;
3578
3729
  /** Returns response with indentations and line breaks. */
3579
3730
  prettyPrint?:
3580
3731
  boolean;
3581
3732
  /** 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. */
3582
3733
  quotaUser?:
3583
3734
  string;
3584
- /**
3585
- * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is
3586
- * recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9),
3587
- * underscores (_), and hyphens (-). The maximum length is 40 characters.
3588
- */
3589
- requestId?:
3590
- string;
3591
3735
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3592
3736
  upload_protocol?:
3593
3737
  string;
@@ -3596,9 +3740,9 @@ declare namespace gapi.client {
3596
3740
  string;
3597
3741
  /** Request body */
3598
3742
  resource:
3599
- WorkflowTemplate;
3743
+ TerminateSessionRequest;
3600
3744
  }): Request<Operation>;
3601
- instantiateInline(request: {
3745
+ terminate(request: {
3602
3746
  /** V1 error format. */
3603
3747
  "$.xgafv"?:
3604
3748
  string;
@@ -3617,29 +3761,18 @@ declare namespace gapi.client {
3617
3761
  /** 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. */
3618
3762
  key?:
3619
3763
  string;
3764
+ /** Required. The name of the session resource to terminate. */
3765
+ name:
3766
+ string;
3620
3767
  /** OAuth 2.0 token for the current user. */
3621
3768
  oauth_token?:
3622
3769
  string;
3623
- /**
3624
- * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For
3625
- * projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For
3626
- * projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}
3627
- */
3628
- parent:
3629
- string;
3630
3770
  /** Returns response with indentations and line breaks. */
3631
3771
  prettyPrint?:
3632
3772
  boolean;
3633
3773
  /** 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. */
3634
3774
  quotaUser?:
3635
3775
  string;
3636
- /**
3637
- * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is
3638
- * recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9),
3639
- * underscores (_), and hyphens (-). The maximum length is 40 characters.
3640
- */
3641
- requestId?:
3642
- string;
3643
3776
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3644
3777
  upload_protocol?:
3645
3778
  string;
@@ -3647,9 +3780,11 @@ declare namespace gapi.client {
3647
3780
  uploadType?:
3648
3781
  string;
3649
3782
  },
3650
- body: WorkflowTemplate): Request<Operation>;
3651
- /** Lists workflows that match the specified filter in the request. */
3652
- list(request?: {
3783
+ body: TerminateSessionRequest): Request<Operation>;
3784
+ }
3785
+ interface SessionTemplatesResource {
3786
+ /** Create an session template, synchronously. */
3787
+ create(request: {
3653
3788
  /** V1 error format. */
3654
3789
  "$.xgafv"?:
3655
3790
  string;
@@ -3671,17 +3806,737 @@ declare namespace gapi.client {
3671
3806
  /** OAuth 2.0 token for the current user. */
3672
3807
  oauth_token?:
3673
3808
  string;
3674
- /** Optional. The maximum number of results to return in each response. */
3675
- pageSize?:
3676
- number;
3677
- /** Optional. The page token, returned by a previous call, to request the next page of results. */
3678
- pageToken?:
3679
- string;
3680
- /**
3681
- * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the
3682
- * resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has
3683
- * the following format: projects/{project_id}/locations/{location}
3684
- */
3809
+ /** Required. The parent resource where this session template will be created. */
3810
+ parent:
3811
+ string;
3812
+ /** Returns response with indentations and line breaks. */
3813
+ prettyPrint?:
3814
+ boolean;
3815
+ /** 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. */
3816
+ quotaUser?:
3817
+ string;
3818
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3819
+ upload_protocol?:
3820
+ string;
3821
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3822
+ uploadType?:
3823
+ string;
3824
+ /** Request body */
3825
+ resource:
3826
+ SessionTemplate;
3827
+ }): Request<SessionTemplate>;
3828
+ create(request: {
3829
+ /** V1 error format. */
3830
+ "$.xgafv"?:
3831
+ string;
3832
+ /** OAuth access token. */
3833
+ access_token?:
3834
+ string;
3835
+ /** Data format for response. */
3836
+ alt?:
3837
+ string;
3838
+ /** JSONP */
3839
+ callback?:
3840
+ string;
3841
+ /** Selector specifying which fields to include in a partial response. */
3842
+ fields?:
3843
+ string;
3844
+ /** 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. */
3845
+ key?:
3846
+ string;
3847
+ /** OAuth 2.0 token for the current user. */
3848
+ oauth_token?:
3849
+ string;
3850
+ /** Required. The parent resource where this session template will be created. */
3851
+ parent:
3852
+ string;
3853
+ /** Returns response with indentations and line breaks. */
3854
+ prettyPrint?:
3855
+ boolean;
3856
+ /** 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. */
3857
+ quotaUser?:
3858
+ string;
3859
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3860
+ upload_protocol?:
3861
+ string;
3862
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3863
+ uploadType?:
3864
+ string;
3865
+ },
3866
+ body: SessionTemplate): Request<SessionTemplate>;
3867
+ /** Deletes a session template. */
3868
+ delete(request?: {
3869
+ /** V1 error format. */
3870
+ "$.xgafv"?:
3871
+ string;
3872
+ /** OAuth access token. */
3873
+ access_token?:
3874
+ string;
3875
+ /** Data format for response. */
3876
+ alt?:
3877
+ string;
3878
+ /** JSONP */
3879
+ callback?:
3880
+ string;
3881
+ /** Selector specifying which fields to include in a partial response. */
3882
+ fields?:
3883
+ string;
3884
+ /** 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. */
3885
+ key?:
3886
+ string;
3887
+ /** Required. The name of the session template resource to delete. */
3888
+ name:
3889
+ string;
3890
+ /** OAuth 2.0 token for the current user. */
3891
+ oauth_token?:
3892
+ string;
3893
+ /** Returns response with indentations and line breaks. */
3894
+ prettyPrint?:
3895
+ boolean;
3896
+ /** 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. */
3897
+ quotaUser?:
3898
+ string;
3899
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3900
+ upload_protocol?:
3901
+ string;
3902
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3903
+ uploadType?:
3904
+ string;
3905
+ }): Request<{}>;
3906
+ /** Gets the resource representation for a session template. */
3907
+ get(request?: {
3908
+ /** V1 error format. */
3909
+ "$.xgafv"?:
3910
+ string;
3911
+ /** OAuth access token. */
3912
+ access_token?:
3913
+ string;
3914
+ /** Data format for response. */
3915
+ alt?:
3916
+ string;
3917
+ /** JSONP */
3918
+ callback?:
3919
+ string;
3920
+ /** Selector specifying which fields to include in a partial response. */
3921
+ fields?:
3922
+ string;
3923
+ /** 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. */
3924
+ key?:
3925
+ string;
3926
+ /** Required. The name of the session template to retrieve. */
3927
+ name:
3928
+ string;
3929
+ /** OAuth 2.0 token for the current user. */
3930
+ oauth_token?:
3931
+ string;
3932
+ /** Returns response with indentations and line breaks. */
3933
+ prettyPrint?:
3934
+ boolean;
3935
+ /** 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. */
3936
+ quotaUser?:
3937
+ string;
3938
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3939
+ upload_protocol?:
3940
+ string;
3941
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3942
+ uploadType?:
3943
+ string;
3944
+ }): Request<SessionTemplate>;
3945
+ /** Lists session templates. */
3946
+ list(request?: {
3947
+ /** V1 error format. */
3948
+ "$.xgafv"?:
3949
+ string;
3950
+ /** OAuth access token. */
3951
+ access_token?:
3952
+ string;
3953
+ /** Data format for response. */
3954
+ alt?:
3955
+ string;
3956
+ /** JSONP */
3957
+ callback?:
3958
+ string;
3959
+ /** Selector specifying which fields to include in a partial response. */
3960
+ fields?:
3961
+ string;
3962
+ /** 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 ... */
3963
+ filter?:
3964
+ string;
3965
+ /** 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. */
3966
+ key?:
3967
+ string;
3968
+ /** OAuth 2.0 token for the current user. */
3969
+ oauth_token?:
3970
+ string;
3971
+ /** Optional. The maximum number of sessions to return in each response. The service may return fewer than this value. */
3972
+ pageSize?:
3973
+ number;
3974
+ /** Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page. */
3975
+ pageToken?:
3976
+ string;
3977
+ /** Required. The parent, which owns this collection of session templates. */
3978
+ parent:
3979
+ string;
3980
+ /** Returns response with indentations and line breaks. */
3981
+ prettyPrint?:
3982
+ boolean;
3983
+ /** 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. */
3984
+ quotaUser?:
3985
+ string;
3986
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3987
+ upload_protocol?:
3988
+ string;
3989
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3990
+ uploadType?:
3991
+ string;
3992
+ }): Request<ListSessionTemplatesResponse>;
3993
+ /** Updates the session template, synchronously.Disable check for update_mask, because all updates will be full replacements. */
3994
+ patch(request: {
3995
+ /** V1 error format. */
3996
+ "$.xgafv"?:
3997
+ string;
3998
+ /** OAuth access token. */
3999
+ access_token?:
4000
+ string;
4001
+ /** Data format for response. */
4002
+ alt?:
4003
+ string;
4004
+ /** JSONP */
4005
+ callback?:
4006
+ string;
4007
+ /** Selector specifying which fields to include in a partial response. */
4008
+ fields?:
4009
+ string;
4010
+ /** 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. */
4011
+ key?:
4012
+ string;
4013
+ /** Required. The resource name of the session template. */
4014
+ name:
4015
+ string;
4016
+ /** OAuth 2.0 token for the current user. */
4017
+ oauth_token?:
4018
+ string;
4019
+ /** Returns response with indentations and line breaks. */
4020
+ prettyPrint?:
4021
+ boolean;
4022
+ /** 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. */
4023
+ quotaUser?:
4024
+ string;
4025
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4026
+ upload_protocol?:
4027
+ string;
4028
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4029
+ uploadType?:
4030
+ string;
4031
+ /** Request body */
4032
+ resource:
4033
+ SessionTemplate;
4034
+ }): Request<SessionTemplate>;
4035
+ patch(request: {
4036
+ /** V1 error format. */
4037
+ "$.xgafv"?:
4038
+ string;
4039
+ /** OAuth access token. */
4040
+ access_token?:
4041
+ string;
4042
+ /** Data format for response. */
4043
+ alt?:
4044
+ string;
4045
+ /** JSONP */
4046
+ callback?:
4047
+ string;
4048
+ /** Selector specifying which fields to include in a partial response. */
4049
+ fields?:
4050
+ string;
4051
+ /** 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. */
4052
+ key?:
4053
+ string;
4054
+ /** Required. The resource name of the session template. */
4055
+ name:
4056
+ string;
4057
+ /** OAuth 2.0 token for the current user. */
4058
+ oauth_token?:
4059
+ string;
4060
+ /** Returns response with indentations and line breaks. */
4061
+ prettyPrint?:
4062
+ boolean;
4063
+ /** 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. */
4064
+ quotaUser?:
4065
+ string;
4066
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4067
+ upload_protocol?:
4068
+ string;
4069
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4070
+ uploadType?:
4071
+ string;
4072
+ },
4073
+ body: SessionTemplate): Request<SessionTemplate>;
4074
+ }
4075
+ interface WorkflowTemplatesResource {
4076
+ /** Creates new workflow template. */
4077
+ create(request: {
4078
+ /** V1 error format. */
4079
+ "$.xgafv"?:
4080
+ string;
4081
+ /** OAuth access token. */
4082
+ access_token?:
4083
+ string;
4084
+ /** Data format for response. */
4085
+ alt?:
4086
+ string;
4087
+ /** JSONP */
4088
+ callback?:
4089
+ string;
4090
+ /** Selector specifying which fields to include in a partial response. */
4091
+ fields?:
4092
+ string;
4093
+ /** 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. */
4094
+ key?:
4095
+ string;
4096
+ /** OAuth 2.0 token for the current user. */
4097
+ oauth_token?:
4098
+ string;
4099
+ /**
4100
+ * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.create, the
4101
+ * resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location
4102
+ * has the following format: projects/{project_id}/locations/{location}
4103
+ */
4104
+ parent:
4105
+ string;
4106
+ /** Returns response with indentations and line breaks. */
4107
+ prettyPrint?:
4108
+ boolean;
4109
+ /** 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. */
4110
+ quotaUser?:
4111
+ string;
4112
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4113
+ upload_protocol?:
4114
+ string;
4115
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4116
+ uploadType?:
4117
+ string;
4118
+ /** Request body */
4119
+ resource:
4120
+ WorkflowTemplate;
4121
+ }): Request<WorkflowTemplate>;
4122
+ create(request: {
4123
+ /** V1 error format. */
4124
+ "$.xgafv"?:
4125
+ string;
4126
+ /** OAuth access token. */
4127
+ access_token?:
4128
+ string;
4129
+ /** Data format for response. */
4130
+ alt?:
4131
+ string;
4132
+ /** JSONP */
4133
+ callback?:
4134
+ string;
4135
+ /** Selector specifying which fields to include in a partial response. */
4136
+ fields?:
4137
+ string;
4138
+ /** 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. */
4139
+ key?:
4140
+ string;
4141
+ /** OAuth 2.0 token for the current user. */
4142
+ oauth_token?:
4143
+ string;
4144
+ /**
4145
+ * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.create, the
4146
+ * resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location
4147
+ * has the following format: projects/{project_id}/locations/{location}
4148
+ */
4149
+ parent:
4150
+ string;
4151
+ /** Returns response with indentations and line breaks. */
4152
+ prettyPrint?:
4153
+ boolean;
4154
+ /** 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. */
4155
+ quotaUser?:
4156
+ string;
4157
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4158
+ upload_protocol?:
4159
+ string;
4160
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4161
+ uploadType?:
4162
+ string;
4163
+ },
4164
+ body: WorkflowTemplate): Request<WorkflowTemplate>;
4165
+ /** Deletes a workflow template. It does not cancel in-progress workflows. */
4166
+ delete(request?: {
4167
+ /** V1 error format. */
4168
+ "$.xgafv"?:
4169
+ string;
4170
+ /** OAuth access token. */
4171
+ access_token?:
4172
+ string;
4173
+ /** Data format for response. */
4174
+ alt?:
4175
+ string;
4176
+ /** JSONP */
4177
+ callback?:
4178
+ string;
4179
+ /** Selector specifying which fields to include in a partial response. */
4180
+ fields?:
4181
+ string;
4182
+ /** 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. */
4183
+ key?:
4184
+ string;
4185
+ /**
4186
+ * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the
4187
+ * resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
4188
+ * projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format:
4189
+ * projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
4190
+ */
4191
+ name:
4192
+ string;
4193
+ /** OAuth 2.0 token for the current user. */
4194
+ oauth_token?:
4195
+ string;
4196
+ /** Returns response with indentations and line breaks. */
4197
+ prettyPrint?:
4198
+ boolean;
4199
+ /** 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. */
4200
+ quotaUser?:
4201
+ string;
4202
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4203
+ upload_protocol?:
4204
+ string;
4205
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4206
+ uploadType?:
4207
+ string;
4208
+ /** Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version. */
4209
+ version?:
4210
+ number;
4211
+ }): Request<{}>;
4212
+ /** Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. */
4213
+ get(request?: {
4214
+ /** V1 error format. */
4215
+ "$.xgafv"?:
4216
+ string;
4217
+ /** OAuth access token. */
4218
+ access_token?:
4219
+ string;
4220
+ /** Data format for response. */
4221
+ alt?:
4222
+ string;
4223
+ /** JSONP */
4224
+ callback?:
4225
+ string;
4226
+ /** Selector specifying which fields to include in a partial response. */
4227
+ fields?:
4228
+ string;
4229
+ /** 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. */
4230
+ key?:
4231
+ string;
4232
+ /**
4233
+ * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the
4234
+ * resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the
4235
+ * resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
4236
+ */
4237
+ name:
4238
+ string;
4239
+ /** OAuth 2.0 token for the current user. */
4240
+ oauth_token?:
4241
+ string;
4242
+ /** Returns response with indentations and line breaks. */
4243
+ prettyPrint?:
4244
+ boolean;
4245
+ /** 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. */
4246
+ quotaUser?:
4247
+ string;
4248
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4249
+ upload_protocol?:
4250
+ string;
4251
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4252
+ uploadType?:
4253
+ string;
4254
+ /** Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version. */
4255
+ version?:
4256
+ number;
4257
+ }): Request<WorkflowTemplate>;
4258
+ /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
4259
+ getIamPolicy(request: {
4260
+ /** V1 error format. */
4261
+ "$.xgafv"?:
4262
+ string;
4263
+ /** OAuth access token. */
4264
+ access_token?:
4265
+ string;
4266
+ /** Data format for response. */
4267
+ alt?:
4268
+ string;
4269
+ /** JSONP */
4270
+ callback?:
4271
+ string;
4272
+ /** Selector specifying which fields to include in a partial response. */
4273
+ fields?:
4274
+ string;
4275
+ /** 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. */
4276
+ key?:
4277
+ string;
4278
+ /** OAuth 2.0 token for the current user. */
4279
+ oauth_token?:
4280
+ string;
4281
+ /** Returns response with indentations and line breaks. */
4282
+ prettyPrint?:
4283
+ boolean;
4284
+ /** 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. */
4285
+ quotaUser?:
4286
+ string;
4287
+ /**
4288
+ * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
4289
+ * field.
4290
+ */
4291
+ resource:
4292
+ string;
4293
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4294
+ upload_protocol?:
4295
+ string;
4296
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4297
+ uploadType?:
4298
+ string;
4299
+ },
4300
+ body: GetIamPolicyRequest): Request<Policy>;
4301
+ /**
4302
+ * Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire
4303
+ * workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The
4304
+ * Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata
4305
+ * (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.
4306
+ */
4307
+ instantiate(request: {
4308
+ /** V1 error format. */
4309
+ "$.xgafv"?:
4310
+ string;
4311
+ /** OAuth access token. */
4312
+ access_token?:
4313
+ string;
4314
+ /** Data format for response. */
4315
+ alt?:
4316
+ string;
4317
+ /** JSONP */
4318
+ callback?:
4319
+ string;
4320
+ /** Selector specifying which fields to include in a partial response. */
4321
+ fields?:
4322
+ string;
4323
+ /** 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. */
4324
+ key?:
4325
+ string;
4326
+ /**
4327
+ * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate,
4328
+ * the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
4329
+ * projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format:
4330
+ * projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
4331
+ */
4332
+ name:
4333
+ string;
4334
+ /** OAuth 2.0 token for the current user. */
4335
+ oauth_token?:
4336
+ string;
4337
+ /** Returns response with indentations and line breaks. */
4338
+ prettyPrint?:
4339
+ boolean;
4340
+ /** 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. */
4341
+ quotaUser?:
4342
+ string;
4343
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4344
+ upload_protocol?:
4345
+ string;
4346
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4347
+ uploadType?:
4348
+ string;
4349
+ /** Request body */
4350
+ resource:
4351
+ InstantiateWorkflowTemplateRequest;
4352
+ }): Request<Operation>;
4353
+ instantiate(request: {
4354
+ /** V1 error format. */
4355
+ "$.xgafv"?:
4356
+ string;
4357
+ /** OAuth access token. */
4358
+ access_token?:
4359
+ string;
4360
+ /** Data format for response. */
4361
+ alt?:
4362
+ string;
4363
+ /** JSONP */
4364
+ callback?:
4365
+ string;
4366
+ /** Selector specifying which fields to include in a partial response. */
4367
+ fields?:
4368
+ string;
4369
+ /** 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. */
4370
+ key?:
4371
+ string;
4372
+ /**
4373
+ * Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate,
4374
+ * the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
4375
+ * projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format:
4376
+ * projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
4377
+ */
4378
+ name:
4379
+ string;
4380
+ /** OAuth 2.0 token for the current user. */
4381
+ oauth_token?:
4382
+ string;
4383
+ /** Returns response with indentations and line breaks. */
4384
+ prettyPrint?:
4385
+ boolean;
4386
+ /** 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. */
4387
+ quotaUser?:
4388
+ string;
4389
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4390
+ upload_protocol?:
4391
+ string;
4392
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4393
+ uploadType?:
4394
+ string;
4395
+ },
4396
+ body: InstantiateWorkflowTemplateRequest): Request<Operation>;
4397
+ /**
4398
+ * Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The
4399
+ * returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be
4400
+ * aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata
4401
+ * (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata
4402
+ * (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.
4403
+ */
4404
+ instantiateInline(request: {
4405
+ /** V1 error format. */
4406
+ "$.xgafv"?:
4407
+ string;
4408
+ /** OAuth access token. */
4409
+ access_token?:
4410
+ string;
4411
+ /** Data format for response. */
4412
+ alt?:
4413
+ string;
4414
+ /** JSONP */
4415
+ callback?:
4416
+ string;
4417
+ /** Selector specifying which fields to include in a partial response. */
4418
+ fields?:
4419
+ string;
4420
+ /** 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. */
4421
+ key?:
4422
+ string;
4423
+ /** OAuth 2.0 token for the current user. */
4424
+ oauth_token?:
4425
+ string;
4426
+ /**
4427
+ * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For
4428
+ * projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For
4429
+ * projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}
4430
+ */
4431
+ parent:
4432
+ string;
4433
+ /** Returns response with indentations and line breaks. */
4434
+ prettyPrint?:
4435
+ boolean;
4436
+ /** 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. */
4437
+ quotaUser?:
4438
+ string;
4439
+ /**
4440
+ * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is
4441
+ * recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9),
4442
+ * underscores (_), and hyphens (-). The maximum length is 40 characters.
4443
+ */
4444
+ requestId?:
4445
+ string;
4446
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4447
+ upload_protocol?:
4448
+ string;
4449
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4450
+ uploadType?:
4451
+ string;
4452
+ /** Request body */
4453
+ resource:
4454
+ WorkflowTemplate;
4455
+ }): Request<Operation>;
4456
+ instantiateInline(request: {
4457
+ /** V1 error format. */
4458
+ "$.xgafv"?:
4459
+ string;
4460
+ /** OAuth access token. */
4461
+ access_token?:
4462
+ string;
4463
+ /** Data format for response. */
4464
+ alt?:
4465
+ string;
4466
+ /** JSONP */
4467
+ callback?:
4468
+ string;
4469
+ /** Selector specifying which fields to include in a partial response. */
4470
+ fields?:
4471
+ string;
4472
+ /** 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. */
4473
+ key?:
4474
+ string;
4475
+ /** OAuth 2.0 token for the current user. */
4476
+ oauth_token?:
4477
+ string;
4478
+ /**
4479
+ * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For
4480
+ * projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For
4481
+ * projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}
4482
+ */
4483
+ parent:
4484
+ string;
4485
+ /** Returns response with indentations and line breaks. */
4486
+ prettyPrint?:
4487
+ boolean;
4488
+ /** 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. */
4489
+ quotaUser?:
4490
+ string;
4491
+ /**
4492
+ * Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is
4493
+ * recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9),
4494
+ * underscores (_), and hyphens (-). The maximum length is 40 characters.
4495
+ */
4496
+ requestId?:
4497
+ string;
4498
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4499
+ upload_protocol?:
4500
+ string;
4501
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4502
+ uploadType?:
4503
+ string;
4504
+ },
4505
+ body: WorkflowTemplate): Request<Operation>;
4506
+ /** Lists workflows that match the specified filter in the request. */
4507
+ list(request?: {
4508
+ /** V1 error format. */
4509
+ "$.xgafv"?:
4510
+ string;
4511
+ /** OAuth access token. */
4512
+ access_token?:
4513
+ string;
4514
+ /** Data format for response. */
4515
+ alt?:
4516
+ string;
4517
+ /** JSONP */
4518
+ callback?:
4519
+ string;
4520
+ /** Selector specifying which fields to include in a partial response. */
4521
+ fields?:
4522
+ string;
4523
+ /** 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. */
4524
+ key?:
4525
+ string;
4526
+ /** OAuth 2.0 token for the current user. */
4527
+ oauth_token?:
4528
+ string;
4529
+ /** Optional. The maximum number of results to return in each response. */
4530
+ pageSize?:
4531
+ number;
4532
+ /** Optional. The page token, returned by a previous call, to request the next page of results. */
4533
+ pageToken?:
4534
+ string;
4535
+ /**
4536
+ * Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the
4537
+ * resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has
4538
+ * the following format: projects/{project_id}/locations/{location}
4539
+ */
3685
4540
  parent:
3686
4541
  string;
3687
4542
  /** Returns response with indentations and line breaks. */
@@ -3883,6 +4738,10 @@ declare namespace gapi.client {
3883
4738
  BatchesResource;
3884
4739
  operations:
3885
4740
  OperationsResource;
4741
+ sessions:
4742
+ SessionsResource;
4743
+ sessionTemplates:
4744
+ SessionTemplatesResource;
3886
4745
  workflowTemplates:
3887
4746
  WorkflowTemplatesResource;
3888
4747
  }
@@ -4714,6 +5573,13 @@ declare namespace gapi.client {
4714
5573
  /** Selector specifying which fields to include in a partial response. */
4715
5574
  fields?:
4716
5575
  string;
5576
+ /**
5577
+ * Optional. The graceful termination timeout for the deletion of the cluster. Indicate the time the request will wait to complete the running jobs on the cluster before its
5578
+ * forceful deletion. Default value is 0 indicating that the user has not enabled the graceful termination. Value can be between 60 second and 6 Hours, in case the graceful
5579
+ * termination is enabled. (There is no separate flag to check the enabling or disabling of graceful termination, it can be checked by the values in the field).
5580
+ */
5581
+ gracefulTerminationTimeout?:
5582
+ string;
4717
5583
  /** 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. */
4718
5584
  key?:
4719
5585
  string;