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

package/index.d.ts

@@ -9,14 +9,14 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://dataform.googleapis.com/$discovery/rest?version=v1beta1
-// Revision: 20241206
+// Revision: 20250202
 
 /// <reference types="gapi.client" />
 
 declare namespace gapi.client {
   /** Load Dataform API v1beta1 */
   function load(
-    urlOrObject: 'https://dataform.googleapis.com/$discovery/rest?version=v1beta1'
+    urlOrObject: 'https://dataform.googleapis.com/$discovery/rest?version=v1beta1',
   ): Promise<void>;
   /** @deprecated Please load APIs with discovery documents. */
   function load(name: 'dataform', version: 'v1beta1'): Promise<void>;
@@ -24,7 +24,7 @@ declare namespace gapi.client {
   function load(
     name: 'dataform',
     version: 'v1beta1',
-    callback: () => any
+    callback: () => any,
   ): void;
 
   namespace dataform {
@@ -66,6 +66,7 @@ declare namespace gapi.client {
       defaultDatabase?: string;
       /** 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. */
       defaultLocation?: string;
+      /** Optional. The default notebook runtime options. */
       defaultNotebookRuntimeOptions?: NotebookRuntimeOptions;
       /** Optional. The default schema (BigQuery dataset ID). */
       defaultSchema?: string;
@@ -109,7 +110,7 @@ declare namespace gapi.client {
     interface CommitRepositoryChangesRequest {
       /** Required. The changes to commit to the repository. */
       commitMetadata?: CommitMetadata;
-      /** A map to the path of the file to the operation. The path is the full file path including filename, from repository root. */
+      /** Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository root. */
       fileOperations?: {[P in string]: FileOperation};
       /** 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. */
       requiredHeadCommitSha?: string;
@@ -149,6 +150,8 @@ declare namespace gapi.client {
       dataformCoreVersion?: string;
       /** Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` */
       gitCommitish?: string;
+      /** Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. */
+      internalMetadata?: string;
       /** Output only. The compilation result's name. */
       name?: string;
       /** Immutable. The name of the release config to compile. Must be in the format `projects/*‍/locations/*‍/repositories/*‍/releaseConfigs/*`. */
@@ -167,6 +170,8 @@ declare namespace gapi.client {
       declaration?: Declaration;
       /** The full path including filename in which this action is located, relative to the workspace root. */
       filePath?: string;
+      /** Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. */
+      internalMetadata?: string;
       /** The notebook executed by this action. */
       notebook?: Notebook;
       /** The database operations executed by this action. */
@@ -187,7 +192,7 @@ declare namespace gapi.client {
       name?: string;
     }
     interface DataEncryptionState {
-      /** The KMS key version name with which data of a resource is encrypted. */
+      /** Required. The KMS key version name with which data of a resource is encrypted. */
       kmsKeyVersionName?: string;
     }
     interface Declaration {
@@ -396,11 +401,11 @@ declare namespace gapi.client {
     interface NotebookAction {
       /** Output only. The code contents of a Notebook to be run. */
       contents?: string;
-      /** Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in GCS buckets. Only set once the job has started to run. */
+      /** Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run. */
       jobId?: string;
     }
     interface NotebookRuntimeOptions {
-      /** Optional. The GCS location to upload the result to. Format: `gs://bucket-name`. */
+      /** Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`. */
       gcsOutputBucket?: string;
     }
     interface OperationMetadata {
@@ -530,6 +535,8 @@ declare namespace gapi.client {
       disabled?: boolean;
       /** Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` */
       gitCommitish?: string;
+      /** Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. */
+      internalMetadata?: string;
       /** Identifier. The release config's name. */
       name?: string;
       /** Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. */
@@ -556,6 +563,8 @@ declare namespace gapi.client {
       displayName?: string;
       /** Optional. If set, configures this repository to be linked to a Git remote. */
       gitRemoteSettings?: GitRemoteSettings;
+      /** Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. */
+      internalMetadata?: string;
       /** Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}` */
       kmsKeyName?: string;
       /** Optional. Repository user labels. */
@@ -580,7 +589,7 @@ declare namespace gapi.client {
     interface ScheduledExecutionRecord {
       /** The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful. */
       errorStatus?: Status;
-      /** The timestamp of this execution attempt. */
+      /** Output only. The timestamp of this execution attempt. */
       executionTime?: string;
       /** The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*‍/locations/*‍/repositories/*‍/workflowInvocations/*`. */
       workflowInvocation?: string;
@@ -590,7 +599,7 @@ declare namespace gapi.client {
       compilationResult?: string;
       /** The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful. */
       errorStatus?: Status;
-      /** The timestamp of this release attempt. */
+      /** Output only. The timestamp of this release attempt. */
       releaseTime?: string;
     }
     interface SearchFilesResponse {
@@ -624,11 +633,11 @@ declare namespace gapi.client {
       message?: string;
     }
     interface Target {
-      /** The action's database (Google Cloud project ID) . */
+      /** Optional. The action's database (Google Cloud project ID) . */
       database?: string;
-      /** The action's name, within `database` and `schema`. */
+      /** Optional. The action's name, within `database` and `schema`. */
       name?: string;
-      /** The action's schema (BigQuery dataset ID), within `database`. */
+      /** Optional. The action's schema (BigQuery dataset ID), within `database`. */
       schema?: string;
     }
     interface TestIamPermissionsRequest {
@@ -642,7 +651,7 @@ declare namespace gapi.client {
     interface UncommittedFileChange {
       /** The file's full path including filename, relative to the workspace root. */
       path?: string;
-      /** Indicates the status of the file. */
+      /** Output only. Indicates the status of the file. */
       state?: string;
     }
     interface WorkflowConfig {
@@ -650,6 +659,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** Optional. Optional schedule (in cron format) for automatic execution of this workflow config. */
       cronSchedule?: string;
+      /** Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. */
+      internalMetadata?: string;
       /** Optional. If left unset, a default InvocationConfig will be used. */
       invocationConfig?: InvocationConfig;
       /** Identifier. The workflow config's name. */
@@ -668,6 +679,8 @@ declare namespace gapi.client {
       compilationResult?: string;
       /** Output only. Only set if the repository has a KMS Key. */
       dataEncryptionState?: DataEncryptionState;
+      /** Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. */
+      internalMetadata?: string;
       /** Immutable. If left unset, a default InvocationConfig will be used. */
       invocationConfig?: InvocationConfig;
       /** Output only. This workflow invocation's timing details. */
@@ -688,6 +701,8 @@ declare namespace gapi.client {
       canonicalTarget?: Target;
       /** Output only. If and only if action's state is FAILED a failure reason is set. */
       failureReason?: string;
+      /** Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. */
+      internalMetadata?: string;
       /** Output only. This action's timing details. `start_time` will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. `end_time` will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state. */
       invocationTiming?: Interval;
       /** Output only. The workflow action's notebook action details. */
@@ -702,6 +717,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key. */
       dataEncryptionState?: DataEncryptionState;
+      /** Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. */
+      internalMetadata?: string;
       /** Identifier. The workspace's name. */
       name?: string;
     }
@@ -781,7 +798,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: CompilationResult
+        body: CompilationResult,
       ): Request<CompilationResult>;
       /** Fetches a single CompilationResult. */
       get(request?: {
@@ -940,7 +957,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: ReleaseConfig
+        body: ReleaseConfig,
       ): Request<ReleaseConfig>;
       /** Deletes a single ReleaseConfig. */
       delete(request?: {
@@ -1027,7 +1044,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<ListReleaseConfigsResponse>;
-      /** Updates a single ReleaseConfig. *Note:* This method does not fully implement AIP/134. In particular: 1. The wildcard entry (***) is treated as a bad request 2. When the *field_mask* is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields */
+      /** Updates a single ReleaseConfig. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields */
       patch(request: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -1087,7 +1104,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: ReleaseConfig
+        body: ReleaseConfig,
       ): Request<ReleaseConfig>;
     }
     interface WorkflowConfigsResource {
@@ -1151,7 +1168,7 @@ declare namespace gapi.client {
           /** Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name. */
           workflowConfigId?: string;
         },
-        body: WorkflowConfig
+        body: WorkflowConfig,
       ): Request<WorkflowConfig>;
       /** Deletes a single WorkflowConfig. */
       delete(request?: {
@@ -1238,7 +1255,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<ListWorkflowConfigsResponse>;
-      /** Updates a single WorkflowConfig. *Note:* This method does not fully implement AIP/134. In particular: 1. The wildcard entry (***) is treated as a bad request 2. When the *field_mask* is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields */
+      /** Updates a single WorkflowConfig. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields */
       patch(request: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -1298,7 +1315,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: WorkflowConfig
+        body: WorkflowConfig,
       ): Request<WorkflowConfig>;
     }
     interface WorkflowInvocationsResource {
@@ -1358,7 +1375,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: CancelWorkflowInvocationRequest
+        body: CancelWorkflowInvocationRequest,
       ): Request<{}>;
       /** Creates a new WorkflowInvocation in a given Repository. */
       create(request: {
@@ -1416,7 +1433,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: WorkflowInvocation
+        body: WorkflowInvocation,
       ): Request<WorkflowInvocation>;
       /** Deletes a single WorkflowInvocation. */
       delete(request?: {
@@ -1596,7 +1613,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: CommitWorkspaceChangesRequest
+        body: CommitWorkspaceChangesRequest,
       ): Request<{}>;
       /** Creates a new Workspace in a given Repository. */
       create(request: {
@@ -1658,7 +1675,7 @@ declare namespace gapi.client {
           /** Required. The ID to use for the workspace, which will become the final component of the workspace's resource name. */
           workspaceId?: string;
         },
-        body: Workspace
+        body: Workspace,
       ): Request<Workspace>;
       /** Deletes a single Workspace. */
       delete(request?: {
@@ -1884,7 +1901,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: InstallNpmPackagesRequest
+        body: InstallNpmPackagesRequest,
       ): Request<{}>;
       /** Lists Workspaces in a given Repository. */
       list(request?: {
@@ -1977,7 +1994,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: MakeDirectoryRequest
+        body: MakeDirectoryRequest,
       ): Request<{}>;
       /** Moves a directory (inside a Workspace), and all of its contents, to a new location. */
       moveDirectory(request: {
@@ -2035,7 +2052,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: MoveDirectoryRequest
+        body: MoveDirectoryRequest,
       ): Request<{}>;
       /** Moves a file (inside a Workspace) to a new location. */
       moveFile(request: {
@@ -2093,7 +2110,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: MoveFileRequest
+        body: MoveFileRequest,
       ): Request<{}>;
       /** Pulls Git commits from the Repository's remote into a Workspace. */
       pull(request: {
@@ -2151,7 +2168,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: PullGitCommitsRequest
+        body: PullGitCommitsRequest,
       ): Request<{}>;
       /** Pushes Git commits from a Workspace to the Repository's remote. */
       push(request: {
@@ -2209,7 +2226,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: PushGitCommitsRequest
+        body: PushGitCommitsRequest,
       ): Request<{}>;
       /** Returns the contents of a given Workspace directory. */
       queryDirectoryContents(request?: {
@@ -2331,7 +2348,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: RemoveDirectoryRequest
+        body: RemoveDirectoryRequest,
       ): Request<{}>;
       /** Deletes a file (inside a Workspace). */
       removeFile(request: {
@@ -2389,7 +2406,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: RemoveFileRequest
+        body: RemoveFileRequest,
       ): Request<{}>;
       /** Performs a Git reset for uncommitted files in a Workspace. */
       reset(request: {
@@ -2447,7 +2464,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: ResetWorkspaceChangesRequest
+        body: ResetWorkspaceChangesRequest,
       ): Request<{}>;
       /** Finds the contents of a given Workspace directory by filter. */
       searchFiles(request?: {
@@ -2510,7 +2527,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: SetIamPolicyRequest
+        body: SetIamPolicyRequest,
       ): Request<Policy>;
       /** 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. */
       testIamPermissions(
@@ -2540,7 +2557,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: TestIamPermissionsRequest
+        body: TestIamPermissionsRequest,
       ): Request<TestIamPermissionsResponse>;
       /** Writes to a file (inside a Workspace). */
       writeFile(request: {
@@ -2598,7 +2615,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: WriteFileRequest
+        body: WriteFileRequest,
       ): Request<{}>;
     }
     interface RepositoriesResource {
@@ -2658,7 +2675,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: CommitRepositoryChangesRequest
+        body: CommitRepositoryChangesRequest,
       ): Request<CommitRepositoryChangesResponse>;
       /** Computes a Repository's Git access token status. */
       computeAccessTokenStatus(request?: {
@@ -2747,7 +2764,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: Repository
+        body: Repository,
       ): Request<Repository>;
       /** Deletes a single Repository. */
       delete(request?: {
@@ -2761,7 +2778,7 @@ declare namespace gapi.client {
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
-        /** 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.) */
+        /** 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.) */
         force?: boolean;
         /** 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. */
         key?: string;
@@ -2927,7 +2944,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<ListRepositoriesResponse>;
-      /** Updates a single Repository. *Note:* This method does not fully implement AIP/134. In particular: 1. The wildcard entry (***) is treated as a bad request 2. When the *field_mask* is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields */
+      /** Updates a single Repository. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields */
       patch(request: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -2987,7 +3004,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: Repository
+        body: Repository,
       ): Request<Repository>;
       /** Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`. */
       queryDirectoryContents(request?: {
@@ -3083,7 +3100,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: SetIamPolicyRequest
+        body: SetIamPolicyRequest,
       ): Request<Policy>;
       /** 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. */
       testIamPermissions(
@@ -3113,7 +3130,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: TestIamPermissionsRequest
+        body: TestIamPermissionsRequest,
       ): Request<TestIamPermissionsResponse>;
       compilationResults: CompilationResultsResource;
       releaseConfigs: ReleaseConfigsResource;
@@ -3209,7 +3226,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<ListLocationsResponse>;
-      /** Update default config for a given project and location. *Note:* This method does not fully implement AIP/134. In particular: 1. The wildcard entry (***) is treated as a bad request 2. When the *field_mask* is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields */
+      /** Update default config for a given project and location. **Note:** *This method does not fully implement*, (see [AIP/134](https://google.aip.dev/134), in particular: - The wildcard entry (**\***) is treated as a bad request - When the **field_mask** is omitted, instead of only updating the set fields, the request is treated as a full update on all modifiable fields */
       updateConfig(request: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -3269,7 +3286,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: Config
+        body: Config,
       ): Request<Config>;
       repositories: RepositoriesResource;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.dataform-v1beta1",
-  "version": "0.0.20241206",
+  "version": "0.0.20250202",
   "description": "TypeScript typings for Dataform API v1beta1",
   "repository": {
     "type": "git",

package/readme.md

@@ -30,7 +30,7 @@ gapi.client.load(
   () => {
     // now we can use:
     // gapi.client.dataform
-  }
+  },
 );
 ```
 
@@ -62,7 +62,7 @@ gapi.auth.authorize(
     } else {
       /* handle authorization error */
     }
-  }
+  },
 );
 ```