@maxim_mazurok/gapi.client.connectors-v2 0.0.20231126 → 0.0.20231213

package/index.d.ts

@@ -9,7 +9,7 @@
 // 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://connectors.googleapis.com/$discovery/rest?version=v2
-// Revision: 20231126
+// Revision: 20231213
 
 /// <reference types="gapi.client" />
 
@@ -24,6 +24,14 @@ declare namespace gapi.client {
   function load(name: 'connectors', version: 'v2', callback: () => any): void;
 
   namespace connectors {
+    interface AccessCredentials {
+      /** OAuth access token. */
+      accessToken?: string;
+      /** Duration till the access token expires. */
+      expiresIn?: string;
+      /** OAuth refresh token. */
+      refreshToken?: string;
+    }
     interface Action {
       /** Brief Description of action */
       description?: string;
@@ -40,6 +48,37 @@ declare namespace gapi.client {
       /** List containing the metadata of result fields. */
       resultMetadata?: ResultMetadata[];
     }
+    interface CheckReadinessResponse {
+      status?: string;
+    }
+    interface CheckStatusResponse {
+      /** When the connector is not in ACTIVE state, the description must be populated to specify the reason why it's not in ACTIVE state. */
+      description?: string;
+      /** State of the connector. */
+      state?: string;
+    }
+    interface DailyCycle {
+      /** Output only. Duration of the time window, set by service producer. */
+      duration?: string;
+      /** Time within the day to start the operations. */
+      startTime?: TimeOfDay;
+    }
+    interface Date {
+      /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
+      day?: number;
+      /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
+      month?: number;
+      /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
+      year?: number;
+    }
+    interface DenyMaintenancePeriod {
+      /** Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be before the end. */
+      endDate?: Date;
+      /** Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be the same or after the start. */
+      startDate?: Date;
+      /** Time in UTC when the Blackout period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC */
+      time?: TimeOfDay;
+    }
     interface Empty {}
     interface Entity {
       /** Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field. */
@@ -55,6 +94,10 @@ declare namespace gapi.client {
       /** The name of the entity type. */
       name?: string;
     }
+    interface ExchangeAuthCodeRequest {}
+    interface ExchangeAuthCodeResponse {
+      accessCredentials?: AccessCredentials;
+    }
     interface ExecuteActionRequest {
       /** Parameters for executing the action. The parameters can be key/value pairs or nested structs. */
       parameters?: {[P in string]: any};
@@ -107,6 +150,42 @@ declare namespace gapi.client {
       /** Specifies whether a null value is allowed. */
       nullable?: boolean;
     }
+    interface Instance {
+      /** consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites). */
+      consumerDefinedName?: string;
+      /** Output only. Timestamp when the resource was created. */
+      createTime?: string;
+      /** Optional. The instance_type of this instance of format: projects/{project_number}/locations/{location_id}/instanceTypes/{instance_type_id}. Instance Type represents a high-level tier or SKU of the service that this instance belong to. When enabled(eg: Maintenance Rollout), Rollout uses 'instance_type' along with 'software_versions' to determine whether instance needs an update or not. */
+      instanceType?: string;
+      /** Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user. */
+      labels?: {[P in string]: string};
+      /** Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For details, please refer to go/mr-user-guide. Should not be set if maintenance_settings.maintenance_policies is set. */
+      maintenancePolicyNames?: {[P in string]: string};
+      /** The MaintenanceSchedule contains the scheduling information of published maintenance schedule with same key as software_versions. */
+      maintenanceSchedules?: {[P in string]: MaintenanceSchedule};
+      /** Optional. The MaintenanceSettings associated with instance. */
+      maintenanceSettings?: MaintenanceSettings;
+      /** Unique name of the resource. It uses the form: `projects/{project_number}/locations/{location_id}/instances/{instance_id}` Note: This name is passed, stored and logged across the rollout system. So use of consumer project_id or any other consumer PII in the name is strongly discouraged for wipeout (go/wipeout) compliance. See go/elysium/project_ids#storage-guidance for more details. */
+      name?: string;
+      /** Optional. notification_parameter are information that service producers may like to include that is not relevant to Rollout. This parameter will only be passed to Gamma and Cloud Logging for notification/logging purpose. */
+      notificationParameters?: {[P in string]: NotificationParameter};
+      /** Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata. */
+      producerMetadata?: {[P in string]: string};
+      /** Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata. */
+      provisionedResources?: ProvisionedResource[];
+      /** Link to the SLM instance template. Only populated when updating SLM instances via SSA's Actuation service adaptor. Service producers with custom control plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they should use software_versions. */
+      slmInstanceTemplate?: string;
+      /** Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description. */
+      sloMetadata?: SloMetadata;
+      /** Software versions that are used to deploy this instance. This can be mutated by rollout services. */
+      softwareVersions?: {[P in string]: string};
+      /** Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use). */
+      state?: string;
+      /** Output only. ID of the associated GCP tenant project. See go/get-instance-metadata. */
+      tenantProjectId?: string;
+      /** Output only. Timestamp when the resource was last modified. */
+      updateTime?: string;
+    }
     interface JsonSchema {
       /** Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema */
       additionalDetails?: {[P in string]: any};
@@ -151,6 +230,70 @@ declare namespace gapi.client {
       /** List of entity type names which contain unsupported Datatypes. Check datatype.proto for more information. */
       unsupportedTypeNames?: string[];
     }
+    interface MaintenancePolicy {
+      /** Output only. The time when the resource was created. */
+      createTime?: string;
+      /** Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512. */
+      description?: string;
+      /** Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user. */
+      labels?: {[P in string]: string};
+      /** Required. MaintenancePolicy name using the form: `projects/{project_id}/locations/{location_id}/maintenancePolicies/{maintenance_policy_id}` where {project_id} refers to a GCP consumer project ID, {location_id} refers to a GCP region/zone, {maintenance_policy_id} must be 1-63 characters long and match the regular expression `[a-z0-9]([-a-z0-9]*[a-z0-9])?`. */
+      name?: string;
+      /** Optional. The state of the policy. */
+      state?: string;
+      /** Maintenance policy applicable to instance update. */
+      updatePolicy?: UpdatePolicy;
+      /** Output only. The time when the resource was updated. */
+      updateTime?: string;
+    }
+    interface MaintenanceSchedule {
+      /** This field is deprecated, and will be always set to true since reschedule can happen multiple times now. This field should not be removed until all service producers remove this for their customers. */
+      canReschedule?: boolean;
+      /** The scheduled end time for the maintenance. */
+      endTime?: string;
+      /** The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy. */
+      rolloutManagementPolicy?: string;
+      /** schedule_deadline_time is the time deadline any schedule start time cannot go beyond, including reschedule. It's normally the initial schedule start time plus maintenance window length (1 day or 1 week). Maintenance cannot be scheduled to start beyond this deadline. */
+      scheduleDeadlineTime?: string;
+      /** The scheduled start time for the maintenance. */
+      startTime?: string;
+    }
+    interface MaintenanceSettings {
+      /** Optional. Exclude instance from maintenance. When true, rollout service will not attempt maintenance on the instance. Rollout service will include the instance in reported rollout progress as not attempted. */
+      exclude?: boolean;
+      /** Optional. If the update call is triggered from rollback, set the value as true. */
+      isRollback?: boolean;
+      /** Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For details, please refer to go/mr-user-guide. Should not be set if maintenance_policy_names is set. If only the name is needed, then only populate MaintenancePolicy.name. */
+      maintenancePolicies?: {[P in string]: MaintenancePolicy};
+    }
+    interface MaintenanceWindow {
+      /** Daily cycle. */
+      dailyCycle?: DailyCycle;
+      /** Weekly cycle. */
+      weeklyCycle?: WeeklyCycle;
+    }
+    interface NodeSloMetadata {
+      /** The location of the node, if different from instance location. */
+      location?: string;
+      /** The id of the node. This should be equal to SaasInstanceNode.node_id. */
+      nodeId?: string;
+      /** If present, this will override eligibility for the node coming from instance or exclusions for specified SLIs. */
+      perSliEligibility?: PerSliSloEligibility;
+    }
+    interface NotificationParameter {
+      /** Optional. Array of string values. e.g. instance's replica information. */
+      values?: string[];
+    }
+    interface PerSliSloEligibility {
+      /** An entry in the eligibilities map specifies an eligibility for a particular SLI for the given instance. The SLI key in the name must be a valid SLI name specified in the Eligibility Exporter binary flags otherwise an error will be emitted by Eligibility Exporter and the oncaller will be alerted. If an SLI has been defined in the binary flags but the eligibilities map does not contain it, the corresponding SLI time series will not be emitted by the Eligibility Exporter. This ensures a smooth rollout and compatibility between the data produced by different versions of the Eligibility Exporters. If eligibilities map contains a key for an SLI which has not been declared in the binary flags, there will be an error message emitted in the Eligibility Exporter log and the metric for the SLI in question will not be emitted. */
+      eligibilities?: {[P in string]: SloEligibility};
+    }
+    interface ProvisionedResource {
+      /** Type of the resource. This can be either a GCP resource or a custom one (e.g. another cloud provider's VM). For GCP compute resources use singular form of the names listed in GCP compute API documentation (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: 'compute-instance', 'compute-disk', 'compute-autoscaler'. */
+      resourceType?: string;
+      /** URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/projects/...)". */
+      resourceUrl?: string;
+    }
     interface Query {
       /** Sets the limit for the maximum number of rows returned after the query execution. */
       maxRows?: string;
@@ -171,6 +314,10 @@ declare namespace gapi.client {
       /** Name of reference entity type. */
       type?: string;
     }
+    interface RefreshAccessTokenRequest {}
+    interface RefreshAccessTokenResponse {
+      accessCredentials?: AccessCredentials;
+    }
     interface ResultMetadata {
       /** The data type of the metadata field */
       dataType?: string;
@@ -181,10 +328,54 @@ declare namespace gapi.client {
       /** Name of the metadata field. */
       name?: string;
     }
+    interface Schedule {
+      /** Allows to define schedule that runs specified day of the week. */
+      day?: string;
+      /** Output only. Duration of the time window, set by service producer. */
+      duration?: string;
+      /** Time within the window to start the operations. */
+      startTime?: TimeOfDay;
+    }
+    interface SloEligibility {
+      /** Whether an instance is eligible or ineligible. */
+      eligible?: boolean;
+      /** User-defined reason for the current value of instance eligibility. Usually, this can be directly mapped to the internal state. An empty reason is allowed. */
+      reason?: string;
+    }
+    interface SloMetadata {
+      /** Optional. List of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch. */
+      nodes?: NodeSloMetadata[];
+      /** Optional. Multiple per-instance SLI eligibilities which apply for individual SLIs. */
+      perSliEligibility?: PerSliSloEligibility;
+      /** Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty. */
+      tier?: string;
+    }
+    interface TimeOfDay {
+      /** Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */
+      hours?: number;
+      /** Minutes of hour of day. Must be from 0 to 59. */
+      minutes?: number;
+      /** Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */
+      nanos?: number;
+      /** Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */
+      seconds?: number;
+    }
     interface UpdateEntitiesWithConditionsResponse {
       /** Response returned by the external system. */
       response?: {[P in string]: any};
     }
+    interface UpdatePolicy {
+      /** Optional. Relative scheduling channel applied to resource. */
+      channel?: string;
+      /** Deny Maintenance Period that is applied to resource to indicate when maintenance is forbidden. The protocol supports zero-to-many such periods, but the current SLM Rollout implementation only supports zero-to-one. */
+      denyMaintenancePeriods?: DenyMaintenancePeriod[];
+      /** Optional. Maintenance window that is applied to resources covered by this policy. */
+      window?: MaintenanceWindow;
+    }
+    interface WeeklyCycle {
+      /** User can specify multiple windows in a week. Minimum of 1 window. */
+      schedule?: Schedule[];
+    }
     interface ActionsResource {
       /** Executes an action with the name specified in the request. The input parameters for executing the action are passed through the body of the ExecuteAction request. */
       execute(request: {
@@ -667,6 +858,114 @@ declare namespace gapi.client {
       entities: EntitiesResource;
     }
     interface ConnectionsResource {
+      /** Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand. */
+      checkReadiness(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        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;
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** 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. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<CheckReadinessResponse>;
+      /** Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not "OK", which indicates that ConnectionStatus itself, not the connection, failed. */
+      checkStatus(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        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;
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** 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. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<CheckStatusResponse>;
+      /** ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials). */
+      exchangeAuthCode(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        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;
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** 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. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: ExchangeAuthCodeRequest;
+      }): Request<ExchangeAuthCodeResponse>;
+      exchangeAuthCode(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          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;
+          name: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** 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. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: ExchangeAuthCodeRequest
+      ): Request<ExchangeAuthCodeResponse>;
       /** Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'. */
       executeSqlQuery(request: {
         /** V1 error format. */
@@ -725,6 +1024,62 @@ declare namespace gapi.client {
         },
         body: ExecuteSqlQueryRequest
       ): Request<ExecuteSqlQueryResponse>;
+      /** RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials). */
+      refreshAccessToken(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        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;
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** 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. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: RefreshAccessTokenRequest;
+      }): Request<RefreshAccessTokenResponse>;
+      refreshAccessToken(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          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;
+          name: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** 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. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: RefreshAccessTokenRequest
+      ): Request<RefreshAccessTokenResponse>;
       actions: ActionsResource;
       entityTypes: EntityTypesResource;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.connectors-v2",
-  "version": "0.0.20231126",
+  "version": "0.0.20231213",
   "description": "TypeScript typings for Connectors API v2",
   "repository": {
     "type": "git",