@maxim_mazurok/gapi.client.dataform-v1beta1 0.0.20250119 → 0.0.20250202

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 +40 -39
  2. package/package.json +1 -1
  3. package/readme.md +2 -2
package/index.d.ts CHANGED
@@ -9,14 +9,14 @@
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://dataform.googleapis.com/$discovery/rest?version=v1beta1
12
- // Revision: 20250119
12
+ // Revision: 20250202
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
16
16
  declare namespace gapi.client {
17
17
  /** Load Dataform API v1beta1 */
18
18
  function load(
19
- urlOrObject: 'https://dataform.googleapis.com/$discovery/rest?version=v1beta1'
19
+ urlOrObject: 'https://dataform.googleapis.com/$discovery/rest?version=v1beta1',
20
20
  ): Promise<void>;
21
21
  /** @deprecated Please load APIs with discovery documents. */
22
22
  function load(name: 'dataform', version: 'v1beta1'): Promise<void>;
@@ -24,7 +24,7 @@ declare namespace gapi.client {
24
24
  function load(
25
25
  name: 'dataform',
26
26
  version: 'v1beta1',
27
- callback: () => any
27
+ callback: () => any,
28
28
  ): void;
29
29
 
30
30
  namespace dataform {
@@ -66,6 +66,7 @@ declare namespace gapi.client {
66
66
  defaultDatabase?: string;
67
67
  /** Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. */
68
68
  defaultLocation?: string;
69
+ /** Optional. The default notebook runtime options. */
69
70
  defaultNotebookRuntimeOptions?: NotebookRuntimeOptions;
70
71
  /** Optional. The default schema (BigQuery dataset ID). */
71
72
  defaultSchema?: string;
@@ -109,7 +110,7 @@ declare namespace gapi.client {
109
110
  interface CommitRepositoryChangesRequest {
110
111
  /** Required. The changes to commit to the repository. */
111
112
  commitMetadata?: CommitMetadata;
112
- /** A map to the path of the file to the operation. The path is the full file path including filename, from repository root. */
113
+ /** Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository root. */
113
114
  fileOperations?: {[P in string]: FileOperation};
114
115
  /** Optional. The commit SHA which must be the repository's current HEAD before applying this commit; otherwise this request will fail. If unset, no validation on the current HEAD commit SHA is performed. */
115
116
  requiredHeadCommitSha?: string;
@@ -191,7 +192,7 @@ declare namespace gapi.client {
191
192
  name?: string;
192
193
  }
193
194
  interface DataEncryptionState {
194
- /** The KMS key version name with which data of a resource is encrypted. */
195
+ /** Required. The KMS key version name with which data of a resource is encrypted. */
195
196
  kmsKeyVersionName?: string;
196
197
  }
197
198
  interface Declaration {
@@ -588,7 +589,7 @@ declare namespace gapi.client {
588
589
  interface ScheduledExecutionRecord {
589
590
  /** The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful. */
590
591
  errorStatus?: Status;
591
- /** The timestamp of this execution attempt. */
592
+ /** Output only. The timestamp of this execution attempt. */
592
593
  executionTime?: string;
593
594
  /** The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*‍/locations/*‍/repositories/*‍/workflowInvocations/*`. */
594
595
  workflowInvocation?: string;
@@ -598,7 +599,7 @@ declare namespace gapi.client {
598
599
  compilationResult?: string;
599
600
  /** The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful. */
600
601
  errorStatus?: Status;
601
- /** The timestamp of this release attempt. */
602
+ /** Output only. The timestamp of this release attempt. */
602
603
  releaseTime?: string;
603
604
  }
604
605
  interface SearchFilesResponse {
@@ -632,11 +633,11 @@ declare namespace gapi.client {
632
633
  message?: string;
633
634
  }
634
635
  interface Target {
635
- /** The action's database (Google Cloud project ID) . */
636
+ /** Optional. The action's database (Google Cloud project ID) . */
636
637
  database?: string;
637
- /** The action's name, within `database` and `schema`. */
638
+ /** Optional. The action's name, within `database` and `schema`. */
638
639
  name?: string;
639
- /** The action's schema (BigQuery dataset ID), within `database`. */
640
+ /** Optional. The action's schema (BigQuery dataset ID), within `database`. */
640
641
  schema?: string;
641
642
  }
642
643
  interface TestIamPermissionsRequest {
@@ -650,7 +651,7 @@ declare namespace gapi.client {
650
651
  interface UncommittedFileChange {
651
652
  /** The file's full path including filename, relative to the workspace root. */
652
653
  path?: string;
653
- /** Indicates the status of the file. */
654
+ /** Output only. Indicates the status of the file. */
654
655
  state?: string;
655
656
  }
656
657
  interface WorkflowConfig {
@@ -797,7 +798,7 @@ declare namespace gapi.client {
797
798
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
798
799
  uploadType?: string;
799
800
  },
800
- body: CompilationResult
801
+ body: CompilationResult,
801
802
  ): Request<CompilationResult>;
802
803
  /** Fetches a single CompilationResult. */
803
804
  get(request?: {
@@ -956,7 +957,7 @@ declare namespace gapi.client {
956
957
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
957
958
  uploadType?: string;
958
959
  },
959
- body: ReleaseConfig
960
+ body: ReleaseConfig,
960
961
  ): Request<ReleaseConfig>;
961
962
  /** Deletes a single ReleaseConfig. */
962
963
  delete(request?: {
@@ -1103,7 +1104,7 @@ declare namespace gapi.client {
1103
1104
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1104
1105
  uploadType?: string;
1105
1106
  },
1106
- body: ReleaseConfig
1107
+ body: ReleaseConfig,
1107
1108
  ): Request<ReleaseConfig>;
1108
1109
  }
1109
1110
  interface WorkflowConfigsResource {
@@ -1167,7 +1168,7 @@ declare namespace gapi.client {
1167
1168
  /** Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name. */
1168
1169
  workflowConfigId?: string;
1169
1170
  },
1170
- body: WorkflowConfig
1171
+ body: WorkflowConfig,
1171
1172
  ): Request<WorkflowConfig>;
1172
1173
  /** Deletes a single WorkflowConfig. */
1173
1174
  delete(request?: {
@@ -1314,7 +1315,7 @@ declare namespace gapi.client {
1314
1315
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1315
1316
  uploadType?: string;
1316
1317
  },
1317
- body: WorkflowConfig
1318
+ body: WorkflowConfig,
1318
1319
  ): Request<WorkflowConfig>;
1319
1320
  }
1320
1321
  interface WorkflowInvocationsResource {
@@ -1374,7 +1375,7 @@ declare namespace gapi.client {
1374
1375
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1375
1376
  uploadType?: string;
1376
1377
  },
1377
- body: CancelWorkflowInvocationRequest
1378
+ body: CancelWorkflowInvocationRequest,
1378
1379
  ): Request<{}>;
1379
1380
  /** Creates a new WorkflowInvocation in a given Repository. */
1380
1381
  create(request: {
@@ -1432,7 +1433,7 @@ declare namespace gapi.client {
1432
1433
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1433
1434
  uploadType?: string;
1434
1435
  },
1435
- body: WorkflowInvocation
1436
+ body: WorkflowInvocation,
1436
1437
  ): Request<WorkflowInvocation>;
1437
1438
  /** Deletes a single WorkflowInvocation. */
1438
1439
  delete(request?: {
@@ -1612,7 +1613,7 @@ declare namespace gapi.client {
1612
1613
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1613
1614
  uploadType?: string;
1614
1615
  },
1615
- body: CommitWorkspaceChangesRequest
1616
+ body: CommitWorkspaceChangesRequest,
1616
1617
  ): Request<{}>;
1617
1618
  /** Creates a new Workspace in a given Repository. */
1618
1619
  create(request: {
@@ -1674,7 +1675,7 @@ declare namespace gapi.client {
1674
1675
  /** Required. The ID to use for the workspace, which will become the final component of the workspace's resource name. */
1675
1676
  workspaceId?: string;
1676
1677
  },
1677
- body: Workspace
1678
+ body: Workspace,
1678
1679
  ): Request<Workspace>;
1679
1680
  /** Deletes a single Workspace. */
1680
1681
  delete(request?: {
@@ -1900,7 +1901,7 @@ declare namespace gapi.client {
1900
1901
  /** Required. The workspace's name. */
1901
1902
  workspace: string;
1902
1903
  },
1903
- body: InstallNpmPackagesRequest
1904
+ body: InstallNpmPackagesRequest,
1904
1905
  ): Request<{}>;
1905
1906
  /** Lists Workspaces in a given Repository. */
1906
1907
  list(request?: {
@@ -1993,7 +1994,7 @@ declare namespace gapi.client {
1993
1994
  /** Required. The workspace's name. */
1994
1995
  workspace: string;
1995
1996
  },
1996
- body: MakeDirectoryRequest
1997
+ body: MakeDirectoryRequest,
1997
1998
  ): Request<{}>;
1998
1999
  /** Moves a directory (inside a Workspace), and all of its contents, to a new location. */
1999
2000
  moveDirectory(request: {
@@ -2051,7 +2052,7 @@ declare namespace gapi.client {
2051
2052
  /** Required. The workspace's name. */
2052
2053
  workspace: string;
2053
2054
  },
2054
- body: MoveDirectoryRequest
2055
+ body: MoveDirectoryRequest,
2055
2056
  ): Request<{}>;
2056
2057
  /** Moves a file (inside a Workspace) to a new location. */
2057
2058
  moveFile(request: {
@@ -2109,7 +2110,7 @@ declare namespace gapi.client {
2109
2110
  /** Required. The workspace's name. */
2110
2111
  workspace: string;
2111
2112
  },
2112
- body: MoveFileRequest
2113
+ body: MoveFileRequest,
2113
2114
  ): Request<{}>;
2114
2115
  /** Pulls Git commits from the Repository's remote into a Workspace. */
2115
2116
  pull(request: {
@@ -2167,7 +2168,7 @@ declare namespace gapi.client {
2167
2168
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2168
2169
  uploadType?: string;
2169
2170
  },
2170
- body: PullGitCommitsRequest
2171
+ body: PullGitCommitsRequest,
2171
2172
  ): Request<{}>;
2172
2173
  /** Pushes Git commits from a Workspace to the Repository's remote. */
2173
2174
  push(request: {
@@ -2225,7 +2226,7 @@ declare namespace gapi.client {
2225
2226
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2226
2227
  uploadType?: string;
2227
2228
  },
2228
- body: PushGitCommitsRequest
2229
+ body: PushGitCommitsRequest,
2229
2230
  ): Request<{}>;
2230
2231
  /** Returns the contents of a given Workspace directory. */
2231
2232
  queryDirectoryContents(request?: {
@@ -2347,7 +2348,7 @@ declare namespace gapi.client {
2347
2348
  /** Required. The workspace's name. */
2348
2349
  workspace: string;
2349
2350
  },
2350
- body: RemoveDirectoryRequest
2351
+ body: RemoveDirectoryRequest,
2351
2352
  ): Request<{}>;
2352
2353
  /** Deletes a file (inside a Workspace). */
2353
2354
  removeFile(request: {
@@ -2405,7 +2406,7 @@ declare namespace gapi.client {
2405
2406
  /** Required. The workspace's name. */
2406
2407
  workspace: string;
2407
2408
  },
2408
- body: RemoveFileRequest
2409
+ body: RemoveFileRequest,
2409
2410
  ): Request<{}>;
2410
2411
  /** Performs a Git reset for uncommitted files in a Workspace. */
2411
2412
  reset(request: {
@@ -2463,7 +2464,7 @@ declare namespace gapi.client {
2463
2464
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2464
2465
  uploadType?: string;
2465
2466
  },
2466
- body: ResetWorkspaceChangesRequest
2467
+ body: ResetWorkspaceChangesRequest,
2467
2468
  ): Request<{}>;
2468
2469
  /** Finds the contents of a given Workspace directory by filter. */
2469
2470
  searchFiles(request?: {
@@ -2526,7 +2527,7 @@ declare namespace gapi.client {
2526
2527
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2527
2528
  uploadType?: string;
2528
2529
  },
2529
- body: SetIamPolicyRequest
2530
+ body: SetIamPolicyRequest,
2530
2531
  ): Request<Policy>;
2531
2532
  /** Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. */
2532
2533
  testIamPermissions(
@@ -2556,7 +2557,7 @@ declare namespace gapi.client {
2556
2557
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2557
2558
  uploadType?: string;
2558
2559
  },
2559
- body: TestIamPermissionsRequest
2560
+ body: TestIamPermissionsRequest,
2560
2561
  ): Request<TestIamPermissionsResponse>;
2561
2562
  /** Writes to a file (inside a Workspace). */
2562
2563
  writeFile(request: {
@@ -2614,7 +2615,7 @@ declare namespace gapi.client {
2614
2615
  /** Required. The workspace's name. */
2615
2616
  workspace: string;
2616
2617
  },
2617
- body: WriteFileRequest
2618
+ body: WriteFileRequest,
2618
2619
  ): Request<{}>;
2619
2620
  }
2620
2621
  interface RepositoriesResource {
@@ -2674,7 +2675,7 @@ declare namespace gapi.client {
2674
2675
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2675
2676
  uploadType?: string;
2676
2677
  },
2677
- body: CommitRepositoryChangesRequest
2678
+ body: CommitRepositoryChangesRequest,
2678
2679
  ): Request<CommitRepositoryChangesResponse>;
2679
2680
  /** Computes a Repository's Git access token status. */
2680
2681
  computeAccessTokenStatus(request?: {
@@ -2763,7 +2764,7 @@ declare namespace gapi.client {
2763
2764
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2764
2765
  uploadType?: string;
2765
2766
  },
2766
- body: Repository
2767
+ body: Repository,
2767
2768
  ): Request<Repository>;
2768
2769
  /** Deletes a single Repository. */
2769
2770
  delete(request?: {
@@ -2777,7 +2778,7 @@ declare namespace gapi.client {
2777
2778
  callback?: string;
2778
2779
  /** Selector specifying which fields to include in a partial response. */
2779
2780
  fields?: string;
2780
- /** If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.) */
2781
+ /** Optional. If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.) */
2781
2782
  force?: boolean;
2782
2783
  /** 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. */
2783
2784
  key?: string;
@@ -3003,7 +3004,7 @@ declare namespace gapi.client {
3003
3004
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3004
3005
  uploadType?: string;
3005
3006
  },
3006
- body: Repository
3007
+ body: Repository,
3007
3008
  ): Request<Repository>;
3008
3009
  /** Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`. */
3009
3010
  queryDirectoryContents(request?: {
@@ -3099,7 +3100,7 @@ declare namespace gapi.client {
3099
3100
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3100
3101
  uploadType?: string;
3101
3102
  },
3102
- body: SetIamPolicyRequest
3103
+ body: SetIamPolicyRequest,
3103
3104
  ): Request<Policy>;
3104
3105
  /** Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. */
3105
3106
  testIamPermissions(
@@ -3129,7 +3130,7 @@ declare namespace gapi.client {
3129
3130
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3130
3131
  uploadType?: string;
3131
3132
  },
3132
- body: TestIamPermissionsRequest
3133
+ body: TestIamPermissionsRequest,
3133
3134
  ): Request<TestIamPermissionsResponse>;
3134
3135
  compilationResults: CompilationResultsResource;
3135
3136
  releaseConfigs: ReleaseConfigsResource;
@@ -3285,7 +3286,7 @@ declare namespace gapi.client {
3285
3286
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3286
3287
  uploadType?: string;
3287
3288
  },
3288
- body: Config
3289
+ body: Config,
3289
3290
  ): Request<Config>;
3290
3291
  repositories: RepositoriesResource;
3291
3292
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.dataform-v1beta1",
3
- "version": "0.0.20250119",
3
+ "version": "0.0.20250202",
4
4
  "description": "TypeScript typings for Dataform API v1beta1",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -30,7 +30,7 @@ gapi.client.load(
30
30
  () => {
31
31
  // now we can use:
32
32
  // gapi.client.dataform
33
- }
33
+ },
34
34
  );
35
35
  ```
36
36
 
@@ -62,7 +62,7 @@ gapi.auth.authorize(
62
62
  } else {
63
63
  /* handle authorization error */
64
64
  }
65
- }
65
+ },
66
66
  );
67
67
  ```
68
68