@maxim_mazurok/gapi.client.metastore-v1 0.0.20250109 → 0.0.20250123

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://metastore.googleapis.com/$discovery/rest?version=v1
-// Revision: 20250109
+// Revision: 20250123
 
 /// <reference types="gapi.client" />
 
 declare namespace gapi.client {
   /** Load Dataproc Metastore API v1 */
   function load(
-    urlOrObject: 'https://metastore.googleapis.com/$discovery/rest?version=v1'
+    urlOrObject: 'https://metastore.googleapis.com/$discovery/rest?version=v1',
   ): Promise<void>;
   /** @deprecated Please load APIs with discovery documents. */
   function load(name: 'metastore', version: 'v1'): Promise<void>;
@@ -60,11 +60,11 @@ declare namespace gapi.client {
       limitConfig?: LimitConfig;
     }
     interface AuxiliaryVersionConfig {
-      /** A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence. */
+      /** Optional. A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in hive-site.xml) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence. */
       configOverrides?: {[P in string]: string};
       /** Output only. The network configuration contains the endpoint URI(s) of the auxiliary Hive metastore service. */
       networkConfig?: NetworkConfig;
-      /** The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version. */
+      /** Optional. The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version. */
       version?: string;
     }
     interface BackendMetastore {
@@ -76,11 +76,11 @@ declare namespace gapi.client {
     interface Backup {
       /** Output only. The time when the backup was started. */
       createTime?: string;
-      /** The description of the backup. */
+      /** Optional. The description of the backup. */
       description?: string;
       /** Output only. The time when the backup finished creating. */
       endTime?: string;
-      /** Immutable. The relative resource name of the backup, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id} */
+      /** Immutable. Identifier. The relative resource name of the backup, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id} */
       name?: string;
       /** Output only. Services that are restoring from the backup. */
       restoringServices?: string[];
@@ -159,9 +159,9 @@ declare namespace gapi.client {
     interface DatabaseDump {
       /** The type of the database. */
       databaseType?: string;
-      /** A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://. */
+      /** Optional. A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://. */
       gcsUri?: string;
-      /** The name of the source database. */
+      /** Optional. The name of the source database. */
       sourceDatabase?: string;
       /** Optional. The type of the database dump. If unspecified, defaults to MYSQL. */
       type?: string;
@@ -172,7 +172,7 @@ declare namespace gapi.client {
     }
     interface Empty {}
     interface EncryptionConfig {
-      /** The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}. */
+      /** Optional. The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}. */
       kmsKey?: string;
     }
     interface ErrorDetails {
@@ -220,13 +220,13 @@ declare namespace gapi.client {
       version?: string;
     }
     interface HiveMetastoreConfig {
-      /** A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen. */
+      /** Optional. A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression a-z?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen. */
       auxiliaryVersions?: {[P in string]: AuxiliaryVersionConfig};
-      /** A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version's AuxiliaryVersionConfig. */
+      /** Optional. A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version's AuxiliaryVersionConfig. */
       configOverrides?: {[P in string]: string};
-      /** The protocol to use for the metastore service endpoint. If unspecified, defaults to THRIFT. */
+      /** Optional. The protocol to use for the metastore service endpoint. If unspecified, defaults to THRIFT. */
       endpointProtocol?: string;
-      /** Information used to configure the Hive metastore service as a service principal in a Kerberos realm. To disable Kerberos, use the UpdateService method and specify this field's path (hive_metastore_config.kerberos_config) in the request's update_mask while omitting this field from the request's service. */
+      /** Optional. Information used to configure the Hive metastore service as a service principal in a Kerberos realm. To disable Kerberos, use the UpdateService method and specify this field's path (hive_metastore_config.kerberos_config) in the request's update_mask while omitting this field from the request's service. */
       kerberosConfig?: KerberosConfig;
       /** Immutable. The Hive metastore schema version. */
       version?: string;
@@ -238,11 +238,11 @@ declare namespace gapi.client {
       version?: string;
     }
     interface KerberosConfig {
-      /** A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC). */
+      /** Optional. A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC). */
       keytab?: Secret;
-      /** A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly. */
+      /** Optional. A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly. */
       krb5ConfigGcsUri?: string;
-      /** A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form primary/instance@REALM, but there is no exact format. */
+      /** Optional. A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form primary/instance@REALM, but there is no exact format. */
       principal?: string;
     }
     interface LatestBackup {
@@ -334,9 +334,9 @@ declare namespace gapi.client {
       supportedHiveMetastoreVersions?: HiveMetastoreVersion[];
     }
     interface MaintenanceWindow {
-      /** The day of week, when the window starts. */
+      /** Optional. The day of week, when the window starts. */
       dayOfWeek?: string;
-      /** The hour of day (0-23) when the window starts. */
+      /** Optional. The hour of day (0-23) when the window starts. */
       hourOfDay?: number;
     }
     interface MetadataExport {
@@ -356,11 +356,11 @@ declare namespace gapi.client {
       createTime?: string;
       /** Immutable. A database dump from a pre-existing metastore's database. */
       databaseDump?: DatabaseDump;
-      /** The description of the metadata import. */
+      /** Optional. The description of the metadata import. */
       description?: string;
       /** Output only. The time when the metadata import finished. */
       endTime?: string;
-      /** Immutable. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}. */
+      /** Immutable. Identifier. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}. */
       name?: string;
       /** Output only. The current state of the metadata import. */
       state?: string;
@@ -505,7 +505,7 @@ declare namespace gapi.client {
       timeZone?: string;
     }
     interface Secret {
-      /** The relative resource name of a Secret Manager secret version, in the following form:projects/{project_number}/secrets/{secret_id}/versions/{version_id}. */
+      /** Optional. The relative resource name of a Secret Manager secret version, in the following form:projects/{project_number}/secrets/{secret_id}/versions/{version_id}. */
       cloudSecret?: string;
     }
     interface Service {
@@ -525,23 +525,23 @@ declare namespace gapi.client {
       hiveMetastoreConfig?: HiveMetastoreConfig;
       /** User-defined labels for the metastore service. */
       labels?: {[P in string]: string};
-      /** The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. */
+      /** Optional. The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. */
       maintenanceWindow?: MaintenanceWindow;
       /** Optional. The setting that defines how metastore metadata should be integrated with external services and systems. */
       metadataIntegration?: MetadataIntegration;
       /** Output only. The metadata management activities of the metastore service. */
       metadataManagementActivity?: MetadataManagementActivity;
-      /** Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. */
+      /** Immutable. Identifier. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. */
       name?: string;
       /** Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. */
       network?: string;
-      /** The configuration specifying the network settings for the Dataproc Metastore service. */
+      /** Optional. The configuration specifying the network settings for the Dataproc Metastore service. */
       networkConfig?: NetworkConfig;
-      /** The TCP port at which the metastore service is reached. Default: 9083. */
+      /** Optional. The TCP port at which the metastore service is reached. Default: 9083. */
       port?: number;
       /** Immutable. The release channel of the service. If unspecified, defaults to STABLE. */
       releaseChannel?: string;
-      /** Scaling configuration of the metastore service. */
+      /** Optional. Scaling configuration of the metastore service. */
       scalingConfig?: ScalingConfig;
       /** Optional. The configuration of scheduled backup for the metastore service. */
       scheduledBackup?: ScheduledBackup;
@@ -549,9 +549,9 @@ declare namespace gapi.client {
       state?: string;
       /** Output only. Additional information about the current state of the metastore service, if available. */
       stateMessage?: string;
-      /** The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. */
+      /** Optional. The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to JSON. */
       telemetryConfig?: TelemetryConfig;
-      /** The tier of the service. */
+      /** Optional. The tier of the service. */
       tier?: string;
       /** Output only. The globally unique resource identifier of the metastore service. */
       uid?: string;
@@ -579,7 +579,7 @@ declare namespace gapi.client {
       message?: string;
     }
     interface TelemetryConfig {
-      /** The output format of the Dataproc Metastore service's logs. */
+      /** Optional. The output format of the Dataproc Metastore service's logs. */
       logFormat?: string;
     }
     interface TestIamPermissionsRequest {
@@ -655,7 +655,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: Federation
+        body: Federation,
       ): Request<Operation>;
       /** Deletes a single federation. */
       delete(request?: {
@@ -841,7 +841,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: Federation
+        body: Federation,
       ): Request<Operation>;
       /** Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. */
       setIamPolicy(
@@ -871,7 +871,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(
@@ -901,7 +901,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: TestIamPermissionsRequest
+        body: TestIamPermissionsRequest,
       ): Request<TestIamPermissionsResponse>;
     }
     interface OperationsResource {
@@ -961,7 +961,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: CancelOperationRequest
+        body: CancelOperationRequest,
       ): Request<{}>;
       /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. */
       delete(request?: {
@@ -1116,7 +1116,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: Backup
+        body: Backup,
       ): Request<Operation>;
       /** Deletes a single backup. */
       delete(request?: {
@@ -1266,7 +1266,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: SetIamPolicyRequest
+        body: SetIamPolicyRequest,
       ): Request<Policy>;
     }
     interface TablesResource {
@@ -1327,7 +1327,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: SetIamPolicyRequest
+        body: SetIamPolicyRequest,
       ): Request<Policy>;
     }
     interface DatabasesResource {
@@ -1388,7 +1388,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: SetIamPolicyRequest
+        body: SetIamPolicyRequest,
       ): Request<Policy>;
       tables: TablesResource;
     }
@@ -1457,7 +1457,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: MetadataImport
+        body: MetadataImport,
       ): Request<Operation>;
       /** Gets details of a single import. */
       get(request?: {
@@ -1535,7 +1535,7 @@ declare namespace gapi.client {
         fields?: string;
         /** 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;
-        /** Immutable. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}. */
+        /** Immutable. Identifier. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}. */
         name: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -1568,7 +1568,7 @@ declare namespace gapi.client {
           fields?: string;
           /** 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;
-          /** Immutable. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}. */
+          /** Immutable. Identifier. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}. */
           name: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
@@ -1585,7 +1585,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: MetadataImport
+        body: MetadataImport,
       ): Request<Operation>;
     }
     interface MigrationExecutionsResource {
@@ -1738,7 +1738,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: AlterMetadataResourceLocationRequest
+        body: AlterMetadataResourceLocationRequest,
       ): Request<Operation>;
       /** Alter metadata table properties. */
       alterTableProperties(request: {
@@ -1796,7 +1796,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: AlterTablePropertiesRequest
+        body: AlterTablePropertiesRequest,
       ): Request<Operation>;
       /** Cancels the ongoing Managed Migration process. */
       cancelMigration(request: {
@@ -1854,7 +1854,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: CancelMigrationRequest
+        body: CancelMigrationRequest,
       ): Request<Operation>;
       /** Completes the managed migration process. The Dataproc Metastore service will switch to using its own backend database after successful migration. */
       completeMigration(request: {
@@ -1912,7 +1912,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: CompleteMigrationRequest
+        body: CompleteMigrationRequest,
       ): Request<Operation>;
       /** Creates a metastore service in a project and location. */
       create(request: {
@@ -1978,7 +1978,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: Service
+        body: Service,
       ): Request<Operation>;
       /** Deletes a single service. */
       delete(request?: {
@@ -2065,7 +2065,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: ExportMetadataRequest
+        body: ExportMetadataRequest,
       ): Request<Operation>;
       /** Gets the details of a single service. */
       get(request?: {
@@ -2214,7 +2214,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: MoveTableToDatabaseRequest
+        body: MoveTableToDatabaseRequest,
       ): Request<Operation>;
       /** Updates the parameters of a single service. */
       patch(request: {
@@ -2230,7 +2230,7 @@ declare namespace gapi.client {
         fields?: string;
         /** 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;
-        /** Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. */
+        /** Immutable. Identifier. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. */
         name: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -2263,7 +2263,7 @@ declare namespace gapi.client {
           fields?: string;
           /** 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;
-          /** Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. */
+          /** Immutable. Identifier. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. */
           name: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
@@ -2280,7 +2280,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: Service
+        body: Service,
       ): Request<Operation>;
       /** Query Dataproc Metastore metadata. */
       queryMetadata(request: {
@@ -2338,7 +2338,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: QueryMetadataRequest
+        body: QueryMetadataRequest,
       ): Request<Operation>;
       /** Restores a service from a backup. */
       restore(request: {
@@ -2396,7 +2396,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: RestoreServiceRequest
+        body: RestoreServiceRequest,
       ): Request<Operation>;
       /** Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. */
       setIamPolicy(
@@ -2426,7 +2426,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: SetIamPolicyRequest
+        body: SetIamPolicyRequest,
       ): Request<Policy>;
       /** Starts the Managed Migration process. */
       startMigration(request: {
@@ -2484,7 +2484,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: StartMigrationRequest
+        body: StartMigrationRequest,
       ): Request<Operation>;
       /** 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(
@@ -2514,7 +2514,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: TestIamPermissionsRequest
+        body: TestIamPermissionsRequest,
       ): Request<TestIamPermissionsResponse>;
       backups: BackupsResource;
       databases: DatabasesResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.metastore-v1",
-  "version": "0.0.20250109",
+  "version": "0.0.20250123",
   "description": "TypeScript typings for Dataproc Metastore API v1",
   "repository": {
     "type": "git",

package/readme.md

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