diff --git a/package-lock.json b/package-lock.json index 49275efc06f..90802ad199c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2799,12 +2799,14 @@ "balanced-match": { "version": "1.0.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "brace-expansion": { "version": "1.1.11", "bundled": true, "dev": true, + "optional": true, "requires": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -2819,17 +2821,20 @@ "code-point-at": { "version": "1.1.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "concat-map": { "version": "0.0.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "console-control-strings": { "version": "1.1.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "core-util-is": { "version": "1.0.2", @@ -2946,7 +2951,8 @@ "inherits": { "version": "2.0.3", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "ini": { "version": "1.3.5", @@ -2958,6 +2964,7 @@ "version": "1.0.0", "bundled": true, "dev": true, + "optional": true, "requires": { "number-is-nan": "^1.0.0" } @@ -2972,6 +2979,7 @@ "version": "3.0.4", "bundled": true, "dev": true, + "optional": true, "requires": { "brace-expansion": "^1.1.7" } @@ -2979,12 +2987,14 @@ "minimist": { "version": "0.0.8", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "minipass": { "version": "2.2.4", "bundled": true, "dev": true, + "optional": true, "requires": { "safe-buffer": "^5.1.1", "yallist": "^3.0.0" @@ -3003,6 +3013,7 @@ "version": "0.5.1", "bundled": true, "dev": true, + "optional": true, "requires": { "minimist": "0.0.8" } @@ -3083,7 +3094,8 @@ "number-is-nan": { "version": "1.0.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "object-assign": { "version": "4.1.1", @@ -3095,6 +3107,7 @@ "version": "1.4.0", "bundled": true, "dev": true, + "optional": true, "requires": { "wrappy": "1" } @@ -3216,6 +3229,7 @@ "version": "1.0.2", "bundled": true, "dev": true, + "optional": true, "requires": { "code-point-at": "^1.0.0", "is-fullwidth-code-point": "^1.0.0", diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index 450675d54e6..4873e973772 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -334,7 +334,7 @@ export namespace adexchangebuyer2_v2beta1 { type?: string; } /** - * A creative and its classification data. Next ID: 35 + * A creative and its classification data. Next ID: 36 */ export interface Schema$Creative { /** @@ -1241,10 +1241,16 @@ export namespace adexchangebuyer2_v2beta1 { */ contexts?: Schema$ServingContext[]; /** - * Any disapprovals bound to this restriction. Only present if + * Disapproval bound to this restriction. Only present if * status=DISAPPROVED. Can be used to filter the response of the * creatives.list method. */ + disapproval?: Schema$Disapproval; + /** + * Any disapprovals bound to this restriction. Only present if + * status=DISAPPROVED. Can be used to filter the response of the + * creatives.list method. Deprecated; please use disapproval field instead. + */ disapprovalReasons?: Schema$Disapproval[]; /** * The status of the creative in this context (for example, it has been diff --git a/src/apis/adsense/v1.4.ts b/src/apis/adsense/v1.4.ts index 8fb7db30ad6..4c778eefea1 100644 --- a/src/apis/adsense/v1.4.ts +++ b/src/apis/adsense/v1.4.ts @@ -179,6 +179,14 @@ export namespace adsense_v1_4 { * The ad code snippet. */ adCode?: string; + /** + * The ad code snippet that goes in the body of an AMP page. + */ + ampBody?: string; + /** + * The ad code snippet that goes in the head of an AMP page. + */ + ampHead?: string; /** * Kind this is, in this case adsense#adCode. */ @@ -800,6 +808,75 @@ export namespace adsense_v1_4 { } + /** + * adsense.accounts.adclients.getAdCode + * @desc Get ad code for a given ad client. + * @alias adsense.accounts.adclients.getAdCode + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.accountId Account which contains the ad client. + * @param {string} params.adClientId Ad client to get the code for. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getAdCode( + params?: Params$Resource$Accounts$Adclients$Getadcode, + options?: MethodOptions): AxiosPromise; + getAdCode( + params: Params$Resource$Accounts$Adclients$Getadcode, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getAdCode( + params: Params$Resource$Accounts$Adclients$Getadcode, + callback: BodyResponseCallback): void; + getAdCode(callback: BodyResponseCallback): void; + getAdCode( + paramsOrCallback?: Params$Resource$Accounts$Adclients$Getadcode| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Accounts$Adclients$Getadcode; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Adclients$Getadcode; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/adsense/v1.4/accounts/{accountId}/adclients/{adClientId}/adcode') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['accountId', 'adClientId'], + pathParams: ['accountId', 'adClientId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * adsense.accounts.adclients.list * @desc List all ad clients in the specified account. @@ -869,6 +946,21 @@ export namespace adsense_v1_4 { } } + export interface Params$Resource$Accounts$Adclients$Getadcode { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Account which contains the ad client. + */ + accountId?: string; + /** + * Ad client to get the code for. + */ + adClientId?: string; + } export interface Params$Resource$Accounts$Adclients$List { /** * Auth client or API Key for the request diff --git a/src/apis/analytics/v3.ts b/src/apis/analytics/v3.ts index d66085f8cf2..8fa7f1b4b2e 100644 --- a/src/apis/analytics/v3.ts +++ b/src/apis/analytics/v3.ts @@ -1476,6 +1476,23 @@ export namespace analytics_v3 { */ username?: string; } + /** + * JSON template for a hash Client Id request resource. + */ + export interface Schema$HashClientIdRequest { + clientId?: string; + kind?: string; + webPropertyId?: string; + } + /** + * JSON template for a hash Client Id response resource. + */ + export interface Schema$HashClientIdResponse { + clientId?: string; + hashedClientId?: string; + kind?: string; + webPropertyId?: string; + } /** * JSON template for an Analytics Remarketing Include Conditions. */ @@ -3071,6 +3088,7 @@ export namespace analytics_v3 { accounts: Resource$Management$Accounts; accountSummaries: Resource$Management$Accountsummaries; accountUserLinks: Resource$Management$Accountuserlinks; + clientId: Resource$Management$Clientid; customDataSources: Resource$Management$Customdatasources; customDimensions: Resource$Management$Customdimensions; customMetrics: Resource$Management$Custommetrics; @@ -3093,6 +3111,7 @@ export namespace analytics_v3 { this.accounts = new Resource$Management$Accounts(root); this.accountSummaries = new Resource$Management$Accountsummaries(root); this.accountUserLinks = new Resource$Management$Accountuserlinks(root); + this.clientId = new Resource$Management$Clientid(root); this.customDataSources = new Resource$Management$Customdatasources(root); this.customDimensions = new Resource$Management$Customdimensions(root); this.customMetrics = new Resource$Management$Custommetrics(root); @@ -3683,6 +3702,101 @@ export namespace analytics_v3 { } + export class Resource$Management$Clientid { + root: Analytics; + constructor(root: Analytics) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * analytics.management.clientId.hashClientId + * @desc Hashes the given Client ID. + * @alias analytics.management.clientId.hashClientId + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().HashClientIdRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + hashClientId( + params?: Params$Resource$Management$Clientid$Hashclientid, + options?: MethodOptions): AxiosPromise; + hashClientId( + params: Params$Resource$Management$Clientid$Hashclientid, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + hashClientId( + params: Params$Resource$Management$Clientid$Hashclientid, + callback: BodyResponseCallback): void; + hashClientId(callback: BodyResponseCallback): + void; + hashClientId( + paramsOrCallback?: Params$Resource$Management$Clientid$Hashclientid| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Management$Clientid$Hashclientid; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Management$Clientid$Hashclientid; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/analytics/v3/management/clientId:hashClientId') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Management$Clientid$Hashclientid { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + + /** + * Request body metadata + */ + requestBody?: Schema$HashClientIdRequest; + } + + export class Resource$Management$Customdatasources { root: Analytics; constructor(root: Analytics) { diff --git a/src/apis/androiddeviceprovisioning/README.md b/src/apis/androiddeviceprovisioning/README.md index 219300961d5..5656962dc2b 100644 --- a/src/apis/androiddeviceprovisioning/README.md +++ b/src/apis/androiddeviceprovisioning/README.md @@ -2,7 +2,7 @@ # @google/androiddeviceprovisioning -> Automates reseller integration into zero-touch enrollment by assigning devices to customers and creating device reports. +> Automates Android zero-touch enrollment for device resellers, customers, and EMMs. ## Installation diff --git a/src/apis/androiddeviceprovisioning/v1.ts b/src/apis/androiddeviceprovisioning/v1.ts index d1835c049a3..30984276fb5 100644 --- a/src/apis/androiddeviceprovisioning/v1.ts +++ b/src/apis/androiddeviceprovisioning/v1.ts @@ -126,8 +126,7 @@ export namespace androiddeviceprovisioning_v1 { */ companyId?: string; /** - * Required. The name of the company. For example _XYZ Corp_. Characters - * allowed are: Latin letters, numerals, hyphens, and spaces. Displayed to + * Required. The name of the company. For example _XYZ Corp_. Displayed to * the customer's employees in the zero-touch enrollment portal. */ companyName?: string; @@ -357,6 +356,10 @@ export namespace androiddeviceprovisioning_v1 { * The ID of the Customer that purchased the device. */ ownerCompanyId?: string; + /** + * The ID of the reseller that claimed the device. + */ + resellerId?: string; /** * Output only. The type of claim made on the device. */ @@ -572,6 +575,35 @@ export namespace androiddeviceprovisioning_v1 { */ customers?: Schema$Company[]; } + /** + * Response message to list customers of the vendor. + */ + export interface Schema$ListVendorCustomersResponse { + /** + * List of customers of the vendor. + */ + customers?: Schema$Company[]; + /** + * A token to retrieve the next page of results. Omitted if no further + * results are available. + */ + nextPageToken?: string; + } + /** + * Response message to list vendors of the partner. + */ + export interface Schema$ListVendorsResponse { + /** + * A token to retrieve the next page of results. Omitted if no further + * results are available. + */ + nextPageToken?: string; + /** + * List of vendors of the reseller partner. Fields `name`, `companyId` and + * `companyName` are populated to the Company object. + */ + vendors?: Schema$Company[]; + } /** * This resource represents a long-running operation that is the result of a * network API call. @@ -1989,11 +2021,13 @@ export namespace androiddeviceprovisioning_v1 { root: Androiddeviceprovisioning; customers: Resource$Partners$Customers; devices: Resource$Partners$Devices; + vendors: Resource$Partners$Vendors; constructor(root: Androiddeviceprovisioning) { this.root = root; this.getRoot.bind(this); this.customers = new Resource$Partners$Customers(root); this.devices = new Resource$Partners$Devices(root); + this.vendors = new Resource$Partners$Vendors(root); } getRoot() { @@ -2993,4 +3027,218 @@ export namespace androiddeviceprovisioning_v1 { */ requestBody?: Schema$UpdateDeviceMetadataInBatchRequest; } + + + export class Resource$Partners$Vendors { + root: Androiddeviceprovisioning; + customers: Resource$Partners$Vendors$Customers; + constructor(root: Androiddeviceprovisioning) { + this.root = root; + this.getRoot.bind(this); + this.customers = new Resource$Partners$Vendors$Customers(root); + } + + getRoot() { + return this.root; + } + + + /** + * androiddeviceprovisioning.partners.vendors.list + * @desc Lists vendors of the partner. + * @alias androiddeviceprovisioning.partners.vendors.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of results to be returned. + * @param {string=} params.pageToken A token identifying a page of results returned by the server. + * @param {string} params.parent Required. The resource name in the format `partners/[PARTNER_ID]`. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Partners$Vendors$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Partners$Vendors$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Partners$Vendors$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Partners$Vendors$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Partners$Vendors$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Vendors$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || + 'https://androiddeviceprovisioning.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/vendors') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Partners$Vendors$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The maximum number of results to be returned. + */ + pageSize?: number; + /** + * A token identifying a page of results returned by the server. + */ + pageToken?: string; + /** + * Required. The resource name in the format `partners/[PARTNER_ID]`. + */ + parent?: string; + } + + export class Resource$Partners$Vendors$Customers { + root: Androiddeviceprovisioning; + constructor(root: Androiddeviceprovisioning) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * androiddeviceprovisioning.partners.vendors.customers.list + * @desc Lists the customers of the vendor. + * @alias androiddeviceprovisioning.partners.vendors.customers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of results to be returned. + * @param {string=} params.pageToken A token identifying a page of results returned by the server. + * @param {string} params.parent Required. The resource name in the format `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Partners$Vendors$Customers$List, + options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Partners$Vendors$Customers$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Partners$Vendors$Customers$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Partners$Vendors$Customers$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Partners$Vendors$Customers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Vendors$Customers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || + 'https://androiddeviceprovisioning.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/customers') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Partners$Vendors$Customers$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The maximum number of results to be returned. + */ + pageSize?: number; + /** + * A token identifying a page of results returned by the server. + */ + pageToken?: string; + /** + * Required. The resource name in the format + * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`. + */ + parent?: string; + } } diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index f1cc5543430..4404beacaec 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -359,6 +359,11 @@ export namespace androidmanagement_v1 { * NonComplianceDetail for the device. */ nonComplianceDetailCondition?: Schema$NonComplianceDetailCondition; + /** + * If set, the rule includes a mitigating action to disable apps specified + * in the list, but app data is preserved. + */ + packageNamesToDisable?: string[]; } /** * A device owned by an enterprise. Unless otherwise noted, all fields are @@ -441,6 +446,11 @@ export namespace androidmanagement_v1 { * The last time the device sent a status report. */ lastStatusReportTime?: string; + /** + * The type of management mode Android Device Policy takes on the device. + * This influences which policy settings are supported. + */ + managementMode?: string; /** * Events related to memory and storage measurements in chronological order. * This information is only available if memoryInfoEnabled is true in the @@ -616,6 +626,11 @@ export namespace androidmanagement_v1 { * enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. */ name?: string; + /** + * Whether the enrollment token is for one time use only. If the flag is set + * to true, only one device can use it for registration. + */ + oneTimeOnly?: boolean; /** * The name of the policy initially applied to the enrolled device, in the * form enterprises/{enterpriseId}/policies/{policyId}. If not specified, @@ -1393,6 +1408,11 @@ export namespace androidmanagement_v1 { * Password requirements. */ passwordRequirements?: Schema$PasswordRequirements; + /** + * Explicit permission or group grants or denials for all apps. These values + * override the default_permission_policy. + */ + permissionGrants?: Schema$PermissionGrant[]; /** * If present, only the input methods provided by packages in this list are * permitted. If this field is present, but the list is empty, then only @@ -1614,6 +1634,10 @@ export namespace androidmanagement_v1 { * Kernel version, for example, 2.6.32.9-g103d848. */ deviceKernelVersion?: string; + /** + * An IETF BCP 47 language code for the primary locale on the device. + */ + primaryLanguageCode?: string; /** * Security patch level, e.g. 2016-05-01. */ @@ -2192,6 +2216,7 @@ export namespace androidmanagement_v1 { * * @param {object} params Parameters for request * @param {string} params.name The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. + * @param {string=} params.wipeDataFlags Optional flags that control the device wiping behavior. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2532,6 +2557,10 @@ export namespace androidmanagement_v1 { * enterprises/{enterpriseId}/devices/{deviceId}. */ name?: string; + /** + * Optional flags that control the device wiping behavior. + */ + wipeDataFlags?: string; } export interface Params$Resource$Enterprises$Devices$Get { /** diff --git a/src/apis/androidpublisher/v2.ts b/src/apis/androidpublisher/v2.ts index 2c91852c8e2..595a4227463 100644 --- a/src/apis/androidpublisher/v2.ts +++ b/src/apis/androidpublisher/v2.ts @@ -674,6 +674,29 @@ export namespace androidpublisher_v2 { */ expectedExpiryTimeMillis?: string; } + /** + * Contains the price change information for a subscription that can be used + * to control the user journey for the price change in the app. This can be in + * the form of seeking confirmation from the user or tailoring the experience + * for a successful conversion. + */ + export interface Schema$SubscriptionPriceChange { + /** + * The new price the subscription will renew with if the price change is + * accepted by the user. + */ + newPrice?: Schema$Price; + /** + * The current state of the price change. Possible values are: - + * Outstanding: State for a pending price change waiting for the user to + * agree. In this state, you can optionally seek confirmation from the user + * using the In-App API. - Accepted: State for an accepted price change + * that the subscription will renew with unless it's canceled. The price + * change takes effect on a future date when the subscription renews. Note + * that the change might not occur when the subscription is renewed next. + */ + state?: number; + } /** * A SubscriptionPurchase resource indicates the status of a user's * subscription purchase. @@ -762,6 +785,13 @@ export namespace androidpublisher_v2 { * price_amount_micros is 1990000. */ priceAmountMicros?: string; + /** + * The latest price change information available. This is present only when + * there is an upcoming price change for the subscription yet to be applied. + * Once the subscription renews with the new price or the subscription is + * canceled, no price change information will be returned. + */ + priceChange?: Schema$SubscriptionPriceChange; /** * ISO 4217 currency code for the subscription price. For example, if the * price is specified in British pounds sterling, price_currency_code is diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index f4b89a57fda..743bcc55710 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -666,6 +666,29 @@ export namespace androidpublisher_v3 { */ expectedExpiryTimeMillis?: string; } + /** + * Contains the price change information for a subscription that can be used + * to control the user journey for the price change in the app. This can be in + * the form of seeking confirmation from the user or tailoring the experience + * for a successful conversion. + */ + export interface Schema$SubscriptionPriceChange { + /** + * The new price the subscription will renew with if the price change is + * accepted by the user. + */ + newPrice?: Schema$Price; + /** + * The current state of the price change. Possible values are: - + * Outstanding: State for a pending price change waiting for the user to + * agree. In this state, you can optionally seek confirmation from the user + * using the In-App API. - Accepted: State for an accepted price change + * that the subscription will renew with unless it's canceled. The price + * change takes effect on a future date when the subscription renews. Note + * that the change might not occur when the subscription is renewed next. + */ + state?: number; + } /** * A SubscriptionPurchase resource indicates the status of a user's * subscription purchase. @@ -754,6 +777,13 @@ export namespace androidpublisher_v3 { * price_amount_micros is 1990000. */ priceAmountMicros?: string; + /** + * The latest price change information available. This is present only when + * there is an upcoming price change for the subscription yet to be applied. + * Once the subscription renews with the new price or the subscription is + * canceled, no price change information will be returned. + */ + priceChange?: Schema$SubscriptionPriceChange; /** * ISO 4217 currency code for the subscription price. For example, if the * price is specified in British pounds sterling, price_currency_code is diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index babf481acdb..ed13dcd4f62 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -588,6 +588,15 @@ export namespace appengine_v1 { */ rolloutStrategy?: string; } + /** + * The entrypoint for the application. + */ + export interface Schema$Entrypoint { + /** + * The format should be a shell command that can be fed to bash -c. + */ + shell?: string; + } /** * Custom static error page to be served when an error occurs. */ @@ -1674,7 +1683,8 @@ export namespace appengine_v1 { */ authFailAction?: string; /** - * Level of login required to access this resource. + * Level of login required to access this resource. Not supported for + * Node.js in the App Engine standard environment. */ login?: string; /** @@ -1683,7 +1693,9 @@ export namespace appengine_v1 { */ redirectHttpResponseCode?: string; /** - * Executes a script to handle the request that matches this URL pattern. + * Executes a script to handle the requests that match this URL pattern. + * Only the auto value is supported for Node.js in the App Engine standard + * environment, for example "script": "auto". */ script?: Schema$ScriptHandler; /** @@ -1762,6 +1774,10 @@ export namespace appengine_v1 { * implemented by the app. */ endpointsApiService?: Schema$EndpointsApiService; + /** + * The entrypoint for the application. + */ + entrypoint?: Schema$Entrypoint; /** * App Engine execution environment for this version.Defaults to standard. */ diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 6d4092d527a..4005da0109a 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -625,6 +625,11 @@ export namespace appengine_v1beta { * case, config_id must be omitted. */ configId?: string; + /** + * Enable or disable trace sampling. By default, this is set to false for + * enabled. + */ + disableTraceSampling?: boolean; /** * Endpoints service name which is the name of the "service" * resource in the Service Management API. For example @@ -637,6 +642,15 @@ export namespace appengine_v1beta { */ rolloutStrategy?: string; } + /** + * The entrypoint for the application. + */ + export interface Schema$Entrypoint { + /** + * The format should be a shell command that can be fed to bash -c. + */ + shell?: string; + } /** * Custom static error page to be served when an error occurs. */ @@ -784,6 +798,11 @@ export namespace appengine_v1beta { * OAuth2 client ID to use for the authentication flow. */ oauth2ClientId?: string; + /** + * InputOnly OAuth client info required to generate client id to be used for + * IAP. + */ + oauth2ClientInfo?: Schema$OAuth2ClientInfo; /** * OAuth2 client secret to use for the authentication flow.For security * reasons, this value cannot be retrieved via the API. Instead, the SHA-256 @@ -1180,6 +1199,21 @@ export namespace appengine_v1beta { */ targetSentPacketsPerSecond?: number; } + export interface Schema$OAuth2ClientInfo { + /** + * Application name to be used in OAuth consent screen. + */ + applicationName?: string; + /** + * Nameof the client to be generated. Optional - If not provided, the name + * will be autogenerated by the backend. + */ + clientName?: string; + /** + * Developer's information to be used in OAuth consent screen. + */ + developerEmailAddress?: string; + } /** * This resource represents a long-running operation that is the result of a * network API call. @@ -1733,7 +1767,8 @@ export namespace appengine_v1beta { */ authFailAction?: string; /** - * Level of login required to access this resource. + * Level of login required to access this resource. Not supported for + * Node.js in the App Engine standard environment. */ login?: string; /** @@ -1742,7 +1777,9 @@ export namespace appengine_v1beta { */ redirectHttpResponseCode?: string; /** - * Executes a script to handle the request that matches this URL pattern. + * Executes a script to handle the requests that match this URL pattern. + * Only the auto value is supported for Node.js in the App Engine standard + * environment, for example "script": "auto". */ script?: Schema$ScriptHandler; /** @@ -1821,6 +1858,10 @@ export namespace appengine_v1beta { * implemented by the app. */ endpointsApiService?: Schema$EndpointsApiService; + /** + * The entrypoint for the application. + */ + entrypoint?: Schema$Entrypoint; /** * App Engine execution environment for this version.Defaults to standard. */ diff --git a/src/apis/appengine/v1beta4.ts b/src/apis/appengine/v1beta4.ts index 449b948bf9b..ea90c1c8d02 100644 --- a/src/apis/appengine/v1beta4.ts +++ b/src/apis/appengine/v1beta4.ts @@ -374,6 +374,11 @@ export namespace appengine_v1beta4 { * specify RolloutStrategy.MANAGED and omit config_id. */ configId?: string; + /** + * Enable or disable trace sampling. By default, this is set to false for + * enabled. + */ + disableTraceSampling?: boolean; /** * Endpoints service name which is the name of the "service" * resource in the Service Management API. For example diff --git a/src/apis/appengine/v1beta5.ts b/src/apis/appengine/v1beta5.ts index a4132df649f..32a8fda6de6 100644 --- a/src/apis/appengine/v1beta5.ts +++ b/src/apis/appengine/v1beta5.ts @@ -374,6 +374,11 @@ export namespace appengine_v1beta5 { * specify RolloutStrategy.MANAGED and omit config_id. */ configId?: string; + /** + * Enable or disable trace sampling. By default, this is set to false for + * enabled. + */ + disableTraceSampling?: boolean; /** * Endpoints service name which is the name of the "service" * resource in the Service Management API. For example diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 58b30ed0b53..5e4666b0595 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -258,6 +258,22 @@ export namespace bigquery_v2 { * [Required] A reference that identifies the dataset. */ datasetReference?: Schema$DatasetReference; + /** + * [Optional] The default partition expiration for all partitioned tables in + * the dataset, in milliseconds. Once this property is set, all + * newly-created partitioned tables in the dataset will have an expirationMs + * property in the timePartitioning settings set to this value, and changing + * the value will only affect new tables, not existing ones. The storage in + * a partition will have an expiration time of its partition time plus this + * value. Setting this property overrides the use of + * defaultTableExpirationMs for partitioned tables: only one of + * defaultTableExpirationMs and defaultPartitionExpirationMs will be used + * for any new partitioned table. If you provide an explicit + * timePartitioning.expirationMs when creating or updating a partitioned + * table, that value takes precedence over the default partition expiration + * time indicated by this property. + */ + defaultPartitionExpirationMs?: string; /** * [Optional] The default lifetime of all tables in the dataset, in * milliseconds. The minimum value is 3600000 milliseconds (one hour). Once @@ -695,6 +711,37 @@ export namespace bigquery_v2 { */ skipLeadingRows?: string; } + export interface Schema$IterationResult { + /** + * [Output-only, Beta] Time taken to run the training iteration in + * milliseconds. + */ + durationMs?: string; + /** + * [Output-only, Beta] Eval loss computed on the eval data at the end of the + * iteration. The eval loss is used for early stopping to avoid overfitting. + * No eval loss if eval_split_method option is specified as no_split or + * auto_split with input data size less than 500 rows. + */ + evalLoss?: number; + /** + * [Output-only, Beta] Index of the ML training iteration, starting from + * zero for each training run. + */ + index?: number; + /** + * [Output-only, Beta] Learning rate used for this iteration, it varies for + * different training iterations if learn_rate_strategy option is not + * constant. + */ + learnRate?: number; + /** + * [Output-only, Beta] Training loss computed on the training data at the + * end of the iteration. The training loss function is defined by model + * type. + */ + trainingLoss?: number; + } export interface Schema$Job { /** * [Required] Describes the job configuration. @@ -1293,6 +1340,18 @@ export namespace bigquery_v2 { * [Output-only] The original estimate of bytes processed for the job. */ estimatedBytesProcessed?: string; + /** + * [Output-only, Beta] Index of current ML training iteration. Updated + * during create model query job to show job progress. + */ + modelTrainingCurrentIteration?: number; + /** + * [Output-only, Beta] Expected number of iterations for the create model + * query job specified as num_iterations in the input query. The actual + * total number of iterations may be less than this number due to early + * stop. + */ + modelTrainingExpectedTotalIteration?: string; /** * [Output-only] The number of rows affected by a DML statement. Present * only for DML statements INSERT, UPDATE or DELETE. @@ -1419,6 +1478,21 @@ export namespace bigquery_v2 { */ export interface Schema$JsonObject {} export interface Schema$JsonValue {} + export interface Schema$ModelDefinition { + /** + * [Output-only, Beta] Model options used for the first training run. These + * options are immutable for subsequent training runs. Default values are + * used for any options not specified in the input query. + */ + modelOptions?: any; + /** + * [Output-only, Beta] Information about ml training runs, each training run + * comprises of multiple iterations and there may be multiple training runs + * for the model if warm start is used or if a user decides to continue a + * previously cancelled query. + */ + trainingRuns?: Schema$TrainingRun[]; + } export interface Schema$ProjectList { /** * A hash of the page of results @@ -1744,6 +1818,12 @@ export namespace bigquery_v2 { * is inherited from the dataset. */ location?: string; + /** + * [Output-only, Beta] Present iff this table represents a ML model. + * Describes the training information for the model, and it is required to + * run 'PREDICT' queries. + */ + model?: Schema$ModelDefinition; /** * [Output-only] The size of this table in bytes, excluding any data in the * streaming buffer. @@ -1970,6 +2050,33 @@ export namespace bigquery_v2 { */ type?: string; } + export interface Schema$TrainingRun { + /** + * [Output-only, Beta] List of each iteration results. + */ + iterationResults?: Schema$IterationResult[]; + /** + * [Output-only, Beta] Training run start time in milliseconds since the + * epoch. + */ + startTime?: string; + /** + * [Output-only, Beta] Different state applicable for a training run. IN + * PROGRESS: Training run is in progress. FAILED: Training run ended due to + * a non-retryable failure. SUCCEEDED: Training run successfully completed. + * CANCELLED: Training run cancelled by the user. + */ + state?: string; + /** + * [Output-only, Beta] Training options used by this training run. These + * options are mutable for subsequent training runs. Default values are + * explicitly stored for options not specified in the input query of the + * first training run. For subsequent training runs, any option not + * explicitly specified in the input query will be copied from the previous + * training run. + */ + trainingOptions?: any; + } export interface Schema$UserDefinedFunctionResource { /** * [Pick one] An inline resource that contains code for a user-defined diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index dd15269924c..5f6c60e7ba1 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -94,8 +94,7 @@ export namespace bigquerydatatransfer_v1 { */ authorizationType?: string; /** - * Data source client id which should be used to receive refresh token. When - * not supplied, no offline credentials are populated for data transfer. + * Data source client id which should be used to receive refresh token. */ clientId?: string; /** @@ -149,10 +148,9 @@ export namespace bigquerydatatransfer_v1 { */ parameters?: Schema$DataSourceParameter[]; /** - * Api auth scopes for which refresh token needs to be obtained. Only valid - * when `client_id` is specified. Ignored otherwise. These are scopes needed - * by a data source to prepare data and ingest them into BigQuery, e.g., - * https://www.googleapis.com/auth/bigquery + * Api auth scopes for which refresh token needs to be obtained. These are + * scopes needed by a data source to prepare data and ingest them into + * BigQuery, e.g., https://www.googleapis.com/auth/bigquery */ scopes?: string[]; /** diff --git a/src/apis/calendar/v3.ts b/src/apis/calendar/v3.ts index ece25a98bcc..65a32d03697 100644 --- a/src/apis/calendar/v3.ts +++ b/src/apis/calendar/v3.ts @@ -804,7 +804,29 @@ export namespace calendar_v3 { * Status of the event. Optional. Possible values are: - * "confirmed" - The event is confirmed. This is the default * status. - "tentative" - The event is tentatively confirmed. - - * "cancelled" - The event is cancelled. + * "cancelled" - The event is cancelled (deleted). The list method + * returns cancelled events only on incremental sync (when syncToken or + * updatedMin are specified) or if the showDeleted flag is set to true. The + * get method always returns them. A cancelled status represents two + * different states depending on the event type: - Cancelled exceptions of + * an uncancelled recurring event indicate that this instance should no + * longer be presented to the user. Clients should store these events for + * the lifetime of the parent recurring event. Cancelled exceptions are only + * guaranteed to have values for the id, recurringEventId and + * originalStartTime fields populated. The other fields might be empty. - + * All other cancelled events represent deleted events. Clients should + * remove their locally synced copies. Such cancelled events will eventually + * disappear, so do not rely on them being available indefinitely. Deleted + * events are only guaranteed to have the id field populated. On the + * organizer's calendar, cancelled events continue to expose event + * details (summary, location, etc.) so that they can be restored + * (undeleted). Similarly, the events to which the user was invited and that + * they manually removed continue to provide details. However, incremental + * sync requests with showDeleted set to false will not return these + * details. If an event changes its organizer (for example via the move + * operation) and the original organizer is not on the attendee list, it + * will leave behind a cancelled event where only the id field is guaranteed + * to be populated. */ status?: string; /** diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index 1b3e728e0ba..02cbeff44a4 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -218,7 +218,7 @@ export namespace chat_v1 { */ eventTime?: string; /** - * The message that triggered the event. + * The message that triggered the event, if applicable. */ message?: Schema$Message; /** diff --git a/src/apis/civicinfo/v2.ts b/src/apis/civicinfo/v2.ts index c7331f764ff..8fb03b48221 100644 --- a/src/apis/civicinfo/v2.ts +++ b/src/apis/civicinfo/v2.ts @@ -228,6 +228,10 @@ export namespace civicinfo_v2 { * ballot. */ ballotPlacement?: string; + /** + * The official title on the ballot for this contest, only where available. + */ + ballotTitle?: string; /** * The candidate choices for this contest. */ @@ -489,6 +493,9 @@ export namespace civicinfo_v2 { */ scope?: string; } + export interface Schema$FieldMetadataProto { + internal?: Schema$InternalFieldMetadataProto; + } /** * Describes a political geography. */ @@ -516,6 +523,38 @@ export namespace civicinfo_v2 { */ officeIndices?: number[]; } + export interface Schema$InternalFieldMetadataProto { + isAuto?: boolean; + sourceSummary?: Schema$InternalSourceSummaryProto; + } + export interface Schema$InternalSourceSummaryProto { + dataset?: string; + provider?: string; + } + export interface Schema$LivegraphBacktraceRecordInfo { + dataSourcePublishMsec?: string; + expId?: string; + expInfo?: Schema$LivegraphBacktraceRecordInfoExpInfo; + isRecon?: boolean; + isWlmThrottled?: boolean; + numberOfTriples?: string; + priority?: string; + process?: string; + proxyReceiveMsec?: string; + proxySentMsec?: string; + recordId?: string; + shouldMonitorLatency?: boolean; + subscriberReceiveMsec?: string; + topicBuildFinishMsec?: string; + topicBuildStartMsec?: string; + version?: string; + } + export interface Schema$LivegraphBacktraceRecordInfoExpInfo { + deletedIns?: string[]; + } + export interface Schema$MessageSet { + recordMessageSetExt?: Schema$LivegraphBacktraceRecordInfo; + } /** * Information about an Office held by one or more Officials. */ @@ -591,6 +630,12 @@ export namespace civicinfo_v2 { */ urls?: string[]; } + export interface Schema$PointProto { + latE7?: number; + lngE7?: number; + metadata?: Schema$FieldMetadataProto; + temporaryData?: Schema$MessageSet; + } /** * A location where a voter can vote. This may be an early vote site, an * election day voting location, or a drop off location for a completed @@ -647,14 +692,7 @@ export namespace civicinfo_v2 { countryName?: string; countryNameCode?: string; dependentLocalityName?: string; - dependentThoroughfareLeadingType?: string; dependentThoroughfareName?: string; - dependentThoroughfarePostDirection?: string; - dependentThoroughfarePreDirection?: string; - dependentThoroughfaresConnector?: string; - dependentThoroughfaresIndicator?: string; - dependentThoroughfaresType?: string; - dependentThoroughfareTrailingType?: string; firmName?: string; isDisputed?: boolean; languageCode?: string; @@ -667,12 +705,20 @@ export namespace civicinfo_v2 { sortingCode?: string; subAdministrativeAreaName?: string; subPremiseName?: string; - thoroughfareLeadingType?: string; thoroughfareName?: string; thoroughfareNumber?: string; - thoroughfarePostDirection?: string; - thoroughfarePreDirection?: string; - thoroughfareTrailingType?: string; + } + export interface Schema$Provenance { + collidedSegmentSource?: Schema$StreetSegmentList; + ctclContestUuid?: string; + ctclOfficeUuid?: string; + datasetId?: string; + precinctId?: string; + precinctSplitId?: string; + tsStreetSegmentId?: string; + vip5PrecinctId?: string; + vip5StreetSegmentId?: string; + vipStreetSegmentId?: string; } export interface Schema$RepresentativeInfoData { /** @@ -771,6 +817,56 @@ export namespace civicinfo_v2 { */ official?: boolean; } + export interface Schema$StreetSegment { + administrationRegionIds?: string[]; + beforeGeocodeId?: string; + catalistUniquePrecinctCode?: string; + city?: string; + cityCouncilDistrict?: string; + congressionalDistrict?: string; + contestIds?: string[]; + countyCouncilDistrict?: string; + countyFips?: string; + datasetId?: string; + earlyVoteSiteByIds?: string[]; + endHouseNumber?: string; + geocodedPoint?: Schema$PointProto; + geographicDivisionOcdIds?: string[]; + id?: string; + judicialDistrict?: string; + mailOnly?: boolean; + municipalDistrict?: string; + ncoaAddress?: string; + oddOrEvens?: string[]; + originalId?: string; + pollinglocationByIds?: string[]; + precinctName?: string; + precinctOcdId?: string; + provenances?: Schema$Provenance[]; + published?: boolean; + schoolDistrict?: string; + startHouseNumber?: string; + startLatE7?: string; + startLngE7?: string; + state?: string; + stateHouseDistrict?: string; + stateSenateDistrict?: string; + streetName?: string; + subAdministrativeAreaName?: string; + surrogateId?: string; + targetsmartUniquePrecinctCode?: string; + townshipDistrict?: string; + unitNumber?: string; + unitType?: string; + vanPrecinctCode?: string; + voterGeographicDivisionOcdIds?: string[]; + wardDistrict?: string; + wildcard?: boolean; + zip?: string; + } + export interface Schema$StreetSegmentList { + segments?: Schema$StreetSegment[]; + } /** * A request for information about a voter. */ @@ -818,9 +914,16 @@ export namespace civicinfo_v2 { */ normalizedInput?: Schema$SimpleAddressType; /** - * If no election ID was specified in the query, and there was more than one - * election with data for the given voter, this will contain information - * about the other elections that could apply. + * When there are multiple elections for a voter address, the otherElections + * field is populated in the API response and there are two + * possibilities: 1. If the earliest election is not the intended election, + * specify the election ID of the desired election in a second API request + * using the electionId field. 2. If these elections occur on the same day, + * the API doesn?t return any polling location, contest, or election + * official information to ensure that an additional query is made. For + * user-facing applications, we recommend displaying these elections to the + * user to disambiguate. A second API request using the electionId field + * should be made for the election that is relevant to the user. */ otherElections?: Schema$Election[]; /** @@ -828,6 +931,7 @@ export namespace civicinfo_v2 { */ pollingLocations?: Schema$PollingLocation[]; precinctId?: string; + segments?: Schema$StreetSegment[]; /** * Local Election Information for the state that the voter votes in. For the * US, there will only be one element in this array. @@ -1033,7 +1137,7 @@ export namespace civicinfo_v2 { * * @param {object} params Parameters for request * @param {string} params.address The registered address of the voter to look up. - * @param {string=} params.electionId The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/elections + * @param {string=} params.electionId The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/electionsIf no election ID is specified in the query and there is more than one election with data for the given voter, the additional elections are provided in the otherElections response field. * @param {boolean=} params.officialOnly If set to true, only data from official state sources will be returned. * @param {boolean=} params.returnAllAvailableData If set to true, the query will return the success codeand include any partial information when it is unable to determine a matching address or unable to determine the election for electionId=0 queries. * @param {().VoterInfoRequest} params.resource Request body data @@ -1121,7 +1225,10 @@ export namespace civicinfo_v2 { address?: string; /** * The unique ID of the election to look up. A list of election IDs can be - * obtained at https://www.googleapis.com/civicinfo/{version}/elections + * obtained at https://www.googleapis.com/civicinfo/{version}/electionsIf no + * election ID is specified in the query and there is more than one election + * with data for the given voter, the additional elections are provided in + * the otherElections response field. */ electionId?: string; /** diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index 4dc4265b741..1d58d4e4384 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -85,7 +85,7 @@ export namespace cloudbuild_v1 { */ paths?: string[]; /** - * Stores timing information for pushing all artifact objects. @OutputOnly + * Output only. Stores timing information for pushing all artifact objects. */ timing?: Schema$TimeSpan; } @@ -149,22 +149,22 @@ export namespace cloudbuild_v1 { */ artifacts?: Schema$Artifacts; /** - * The ID of the `BuildTrigger` that triggered this build, if it was - * triggered automatically. @OutputOnly + * Output only. The ID of the `BuildTrigger` that triggered this build, if + * it was triggered automatically. */ buildTriggerId?: string; /** - * Time at which the request to create the build was received. @OutputOnly + * Output only. Time at which the request to create the build was received. */ createTime?: string; /** - * Time at which execution of the build was finished. The difference - * between finish_time and start_time is the duration of the build's - * execution. @OutputOnly + * Output only. Time at which execution of the build was finished. The + * difference between finish_time and start_time is the duration of the + * build's execution. */ finishTime?: string; /** - * Unique identifier of the build. @OutputOnly + * Output only. Unique identifier of the build. */ id?: string; /** @@ -184,7 +184,7 @@ export namespace cloudbuild_v1 { */ logsBucket?: string; /** - * URL to logs for this build in Google Cloud Console. @OutputOnly + * Output only. URL to logs for this build in Google Cloud Console. */ logUrl?: string; /** @@ -192,11 +192,11 @@ export namespace cloudbuild_v1 { */ options?: Schema$BuildOptions; /** - * ID of the project. @OutputOnly. + * Output only. ID of the project. */ projectId?: string; /** - * Results of the build. @OutputOnly + * Output only. Results of the build. */ results?: Schema$Results; /** @@ -208,19 +208,19 @@ export namespace cloudbuild_v1 { */ source?: Schema$Source; /** - * A permanent fixed identifier for source. @OutputOnly + * Output only. A permanent fixed identifier for source. */ sourceProvenance?: Schema$SourceProvenance; /** - * Time at which execution of the build was started. @OutputOnly + * Output only. Time at which execution of the build was started. */ startTime?: string; /** - * Status of the build. @OutputOnly + * Output only. Status of the build. */ status?: string; /** - * Customer-readable message about the current status. @OutputOnly + * Output only. Customer-readable message about the current status. */ statusDetail?: string; /** @@ -242,10 +242,10 @@ export namespace cloudbuild_v1 { */ timeout?: string; /** - * Stores timing information for phases of the build. Valid keys are: * - * BUILD: time to execute all build steps * PUSH: time to push all specified - * images. * FETCHSOURCE: time to fetch source. If the build does not - * specify source or images, these keys will not be included. @OutputOnly + * Output only. Stores timing information for phases of the build. Valid + * keys are: * BUILD: time to execute all build steps * PUSH: time to push + * all specified images. * FETCHSOURCE: time to fetch source. If the build + * does not specify source or images, these keys will not be included. */ timing?: any; } @@ -357,9 +357,9 @@ export namespace cloudbuild_v1 { */ secretEnv?: string[]; /** - * Status of the build step. At this time, build step status is only updated - * on build completion; step status is not updated in real-time as the build - * progresses. @OutputOnly + * Output only. Status of the build step. At this time, build step status is + * only updated on build completion; step status is not updated in real-time + * as the build progresses. */ status?: string; /** @@ -369,7 +369,7 @@ export namespace cloudbuild_v1 { */ timeout?: string; /** - * Stores timing information for executing this build step. @OutputOnly + * Output only. Stores timing information for executing this build step. */ timing?: Schema$TimeSpan; /** @@ -399,7 +399,7 @@ export namespace cloudbuild_v1 { */ build?: Schema$Build; /** - * Time when the trigger was created. @OutputOnly + * Output only. Time when the trigger was created. */ createTime?: string; /** @@ -416,7 +416,7 @@ export namespace cloudbuild_v1 { */ filename?: string; /** - * Unique identifier of the trigger. @OutputOnly + * Output only. Unique identifier of the trigger. */ id?: string; /** @@ -445,7 +445,7 @@ export namespace cloudbuild_v1 { */ name?: string; /** - * Stores timing information for pushing the specified image. @OutputOnly + * Output only. Stores timing information for pushing the specified image. */ pushTiming?: Schema$TimeSpan; } @@ -660,14 +660,13 @@ export namespace cloudbuild_v1 { */ export interface Schema$SourceProvenance { /** - * Hash(es) of the build source, which can be used to verify that the - * original source integrity was maintained in the build. Note that - * `FileHashes` will only be populated if `BuildOptions` has requested a + * Output only. Hash(es) of the build source, which can be used to verify + * that the originalsource integrity was maintained in the build. Note that + * `FileHashes` willonly be populated if `BuildOptions` has requested a * `SourceProvenanceHash`. The keys to this map are file paths used as * build source and the values contain the hash values for those files. If * the build source came in a single package such as a gzipped tarfile * (`.tar.gz`), the `FileHash` will be for the single path to that file. - * @OutputOnly */ fileHashes?: any; /** diff --git a/src/apis/clouddebugger/v2.ts b/src/apis/clouddebugger/v2.ts index 8942e07a4e4..4b1288f212b 100644 --- a/src/apis/clouddebugger/v2.ts +++ b/src/apis/clouddebugger/v2.ts @@ -534,6 +534,12 @@ export namespace clouddebugger_v2 { * Represents a location in the source code. */ export interface Schema$SourceLocation { + /** + * Column within a line. The first column in a line as the value `1`. Agents + * that do not support setting breakpoints on specific columns ignore this + * field. + */ + column?: number; /** * Line inside the file. The first line in the file has the value `1`. */ diff --git a/src/apis/clouderrorreporting/v1beta1.ts b/src/apis/clouderrorreporting/v1beta1.ts index fccd33b08f5..608f45109b2 100644 --- a/src/apis/clouderrorreporting/v1beta1.ts +++ b/src/apis/clouderrorreporting/v1beta1.ts @@ -620,12 +620,12 @@ export namespace clouderrorreporting_v1beta1 { /** * clouderrorreporting.projects.events.report - * @desc Report an individual error event. This endpoint accepts - * either an OAuth token, or an API key for - * authentication. To use an API key, append it to the URL as the value of a - * `key` parameter. For example: 
POST
-     * https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456
+ * @desc Report an individual error event. This endpoint accepts **either** + * an OAuth token, **or** an [API + * key](https://support.google.com/cloud/answer/6158862) for authentication. + * To use an API key, append it to the URL as the value of a `key` + * parameter. For example: `POST + * https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456` * @alias clouderrorreporting.projects.events.report * @memberOf! () * diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index 353c7bfa685..3670b892f27 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -117,6 +117,11 @@ export namespace cloudfunctions_v1 { * `source_location`. */ entryPoint?: string; + /** + * **Beta Feature** Environment variables that shall be available during + * function execution. + */ + environmentVariables?: any; /** * A source that fires events in response to a condition in another service. */ @@ -129,11 +134,31 @@ export namespace cloudfunctions_v1 { * Labels associated with this Cloud Function. */ labels?: any; + /** + * The limit on the maximum number of function instances that may coexist at + * a given time. This feature is currently in alpha, available only for + * whitelisted users. + */ + maxInstances?: number; /** * A user-defined name of the function. Function names must be unique * globally and match pattern `projects/x/locations/x/functions/x */ name?: string; + /** + * The VPC Network that this cloud function can connect to. It can be either + * the fully-qualified URI, or the short name of the network resource. If + * the short network name is used, the network must belong to the same + * project. Otherwise, it must belong to a project within the same + * organization. The format of this field is either + * `projects/{project}/global/networks/{network}` or `{network}`, where + * {project} is a project id where the network is defined, and {network} is + * the short name of the network. See [the VPC + * documentation](https://cloud.google.com/compute/docs/vpc) for more + * information on connecting Cloud projects. This feature is currently in + * alpha, available only for whitelisted users. + */ + network?: string; /** * The runtime in which the function is going to run. If empty, defaults to * Node.js 6. diff --git a/src/apis/cloudfunctions/v1beta2.ts b/src/apis/cloudfunctions/v1beta2.ts index ddffb022016..12d44538c6f 100644 --- a/src/apis/cloudfunctions/v1beta2.ts +++ b/src/apis/cloudfunctions/v1beta2.ts @@ -113,6 +113,11 @@ export namespace cloudfunctions_v1beta2 { * `source_location`. */ entryPoint?: string; + /** + * **Beta Feature** Environment variables that shall be available during + * function execution. + */ + environmentVariables?: any; /** * A source that fires events in response to a condition in another service. */ @@ -131,11 +136,31 @@ export namespace cloudfunctions_v1beta2 { * active operation. */ latestOperation?: string; + /** + * The limit on the maximum number of function instances that may coexist at + * a given time. This feature is currently in alpha, available only for + * whitelisted users. + */ + maxInstances?: number; /** * A user-defined name of the function. Function names must be unique * globally and match pattern `projects/x/locations/x/functions/x */ name?: string; + /** + * The VPC Network that this cloud function can connect to. It can be either + * the fully-qualified URI, or the short name of the network resource. If + * the short network name is used, the network must belong to the same + * project. Otherwise, it must belong to a project within the same + * organization. The format of this field is either + * `projects/{project}/global/networks/{network}` or `{network}`, where + * {project} is a project id where the network is defined, and {network} is + * the short name of the network. See [the VPC + * documentation](https://cloud.google.com/compute/docs/vpc) for more + * information on connecting Cloud projects. This feature is currently in + * alpha, available only for whitelisted users. + */ + network?: string; /** * The runtime in which the function is going to run. If empty, defaults to * Node.js 6. diff --git a/src/apis/cloudiot/v1.ts b/src/apis/cloudiot/v1.ts index d95dcf4af50..fd6fa501dd7 100644 --- a/src/apis/cloudiot/v1.ts +++ b/src/apis/cloudiot/v1.ts @@ -88,7 +88,7 @@ export namespace cloudiot_v1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index 50faa78f234..09ed83b9cb8 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -143,7 +143,7 @@ export namespace cloudkms_v1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } @@ -1897,7 +1897,7 @@ export namespace cloudkms_v1 { /** * cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion - * @desc Update the version of a CryptoKey that will be used in Encrypt + * @desc Update the version of a CryptoKey that will be used in Encrypt. * @alias * cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion * @memberOf! () diff --git a/src/apis/cloudprofiler/README.md b/src/apis/cloudprofiler/README.md new file mode 100644 index 00000000000..fb927404cba --- /dev/null +++ b/src/apis/cloudprofiler/README.md @@ -0,0 +1,27 @@ +Google Inc. logo + +# @google/cloudprofiler + +> Manages continuous profiling information. + +## Installation + +```sh +$ npm install @google/cloudprofiler +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/google/google-api-nodejs-client). + +## License +This library is licensed under Apache 2.0. Full license text is available in [COPYING](https://github.com/google/google-api-nodejs-client/blob/master/COPYING). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/master/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/google/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/cloudprofiler/index.ts b/src/apis/cloudprofiler/index.ts new file mode 100644 index 00000000000..ac83eb17235 --- /dev/null +++ b/src/apis/cloudprofiler/index.ts @@ -0,0 +1,29 @@ +// Copyright 2018, Google, LLC. +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {getAPI, GoogleConfigurable} from '../../shared/src'; +import {cloudprofiler_v2} from './v2'; + +export const VERSIONS = { + 'v2': cloudprofiler_v2.Cloudprofiler, +}; + +export function cloudprofiler(version: 'v2'): cloudprofiler_v2.Cloudprofiler; +export function cloudprofiler(options: cloudprofiler_v2.Options): + cloudprofiler_v2.Cloudprofiler; +export function cloudprofiler( + this: GoogleConfigurable, versionOrOptions: 'v2'|cloudprofiler_v2.Options) { + return getAPI('cloudprofiler', versionOrOptions, VERSIONS, this); +} diff --git a/src/apis/cloudprofiler/package.json b/src/apis/cloudprofiler/package.json new file mode 100644 index 00000000000..ad49d65a112 --- /dev/null +++ b/src/apis/cloudprofiler/package.json @@ -0,0 +1,24 @@ +{ + "name": "@google/cloudprofiler", + "version": "0.1.0", + "description": "cloudprofiler", + "main": "index.js", + "types": "index.d.ts", + "keywords": ["google"], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/google/google-api-nodejs-client", + "bugs": { + "url" : "https://github.com/google/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url" : "https://github.com/google/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=6.0.0" + }, + "dependencies": { + "googleapis-common": "^0.1.0" + } +} diff --git a/src/apis/cloudprofiler/v2.ts b/src/apis/cloudprofiler/v2.ts new file mode 100644 index 00000000000..0d7d015c2e1 --- /dev/null +++ b/src/apis/cloudprofiler/v2.ts @@ -0,0 +1,457 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {AxiosPromise} from 'axios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; + +import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from '../../shared/src'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace cloudprofiler_v2 { + export interface Options extends GlobalOptions { + version: 'v2'; + } + + /** + * Stackdriver Profiler API + * + * Manages continuous profiling information. + * + * @example + * const {google} = require('googleapis'); + * const cloudprofiler = google.cloudprofiler('v2'); + * + * @namespace cloudprofiler + * @type {Function} + * @version v2 + * @variation v2 + * @param {object=} options Options for Cloudprofiler + */ + export class Cloudprofiler { + _options: GlobalOptions; + google?: GoogleConfigurable; + root = this; + + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.projects = new Resource$Projects(this); + } + + getRoot() { + return this.root; + } + } + + /** + * CreateProfileRequest describes a profile resource online creation request. + * The deployment field must be populated. The profile_type specifies the list + * of profile types supported by the agent. The creation call will hang until + * a profile of one of these types needs to be collected. + */ + export interface Schema$CreateProfileRequest { + /** + * Deployment details. + */ + deployment?: Schema$Deployment; + /** + * One or more profile types that the agent is capable of providing. + */ + profileType?: string[]; + } + /** + * Deployment contains the deployment identification information. + */ + export interface Schema$Deployment { + /** + * Labels identify the deployment within the user universe and same target. + * Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`. + * Value for an individual label must be <= 512 bytes, the total size of + * all label names and values must be <= 1024 bytes. Label named + * "language" can be used to record the programming language of + * the profiled deployment. The standard choices for the value include + * "java", "go", "python", "ruby", + * "nodejs", "php", "dotnet". For deployments + * running on Google Cloud Platform, "zone" or "region" + * label should be present describing the deployment location. An example of + * a zone is "us-central1-a", an example of a region is + * "us-central1" or "us-central". + */ + labels?: any; + /** + * Project ID is the ID of a cloud project. Validation regex: + * `^a-z{4,61}[a-z0-9]$`. + */ + projectId?: string; + /** + * Target is the service name used to group related deployments: * Service + * name for GAE Flex / Standard. * Cluster and container name for GKE. * + * User-specified string for direct GCE profiling (e.g. Java). * Job name + * for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`. + */ + target?: string; + } + /** + * Profile resource. + */ + export interface Schema$Profile { + /** + * Deployment this profile corresponds to. + */ + deployment?: Schema$Deployment; + /** + * Duration of the profiling session. Input (for the offline mode) or output + * (for the online mode). The field represents requested profiling duration. + * It may slightly differ from the effective profiling duration, which is + * recorded in the profile data, in case the profiling can't be stopped + * immediately (e.g. in case stopping the profiling is handled + * asynchronously). + */ + duration?: string; + /** + * Input only. Labels associated to this specific profile. These labels will + * get merged with the deployment labels for the final data set. See + * documentation on deployment labels for validation rules and limits. + */ + labels?: any; + /** + * Output only. Opaque, server-assigned, unique ID for this profile. + */ + name?: string; + /** + * Input only. Profile bytes, as a gzip compressed serialized proto, the + * format is + * https://github.com/google/pprof/blob/master/proto/profile.proto. + */ + profileBytes?: string; + /** + * Type of profile. For offline mode, this must be specified when creating + * the profile. For online mode it is assigned and returned by the server. + */ + profileType?: string; + } + + + export class Resource$Projects { + root: Cloudprofiler; + profiles: Resource$Projects$Profiles; + constructor(root: Cloudprofiler) { + this.root = root; + this.getRoot.bind(this); + this.profiles = new Resource$Projects$Profiles(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Profiles { + root: Cloudprofiler; + constructor(root: Cloudprofiler) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudprofiler.projects.profiles.create + * @desc CreateProfile creates a new profile resource in the online mode. + * The server ensures that the new profiles are created at a constant rate + * per deployment, so the creation request may hang for some time until the + * next profile session is available. The request may fail with ABORTED + * error if the creation is not available within ~1m, the response will + * indicate the duration of the backoff the client should take before + * attempting creating a profile again. The backoff duration is returned in + * google.rpc.RetryInfo extension on the response status. To a gRPC client, + * the extension will be return as a binary-serialized proto in the trailing + * metadata item named "google.rpc.retryinfo-bin". + * @alias cloudprofiler.projects.profiles.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Parent project to create the profile in. + * @param {().CreateProfileRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Profiles$Create, + options?: MethodOptions): AxiosPromise; + create( + params: Params$Resource$Projects$Profiles$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Projects$Profiles$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Projects$Profiles$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Profiles$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Profiles$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudprofiler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/profiles') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudprofiler.projects.profiles.createOffline + * @desc CreateOfflineProfile creates a new profile resource in the offline + * mode. The client provides the profile to create along with the profile + * bytes, the server records it. + * @alias cloudprofiler.projects.profiles.createOffline + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Parent project to create the profile in. + * @param {().Profile} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + createOffline( + params?: Params$Resource$Projects$Profiles$Createoffline, + options?: MethodOptions): AxiosPromise; + createOffline( + params: Params$Resource$Projects$Profiles$Createoffline, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + createOffline( + params: Params$Resource$Projects$Profiles$Createoffline, + callback: BodyResponseCallback): void; + createOffline(callback: BodyResponseCallback): void; + createOffline( + paramsOrCallback?: Params$Resource$Projects$Profiles$Createoffline| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Profiles$Createoffline; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Profiles$Createoffline; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudprofiler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/profiles:createOffline') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudprofiler.projects.profiles.patch + * @desc UpdateProfile updates the profile bytes and labels on the profile + * resource created in the online mode. Updating the bytes for profiles + * created in the offline mode is currently not supported: the profile + * content must be provided at the time of the profile creation. + * @alias cloudprofiler.projects.profiles.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. Opaque, server-assigned, unique ID for this profile. + * @param {string=} params.updateMask Field mask used to specify the fields to be overwritten. Currently only profile_bytes and labels fields are supported by UpdateProfile, so only those fields can be specified in the mask. When no mask is provided, all fields are overwritten. + * @param {().Profile} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Projects$Profiles$Patch, + options?: MethodOptions): AxiosPromise; + patch( + params: Params$Resource$Projects$Profiles$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Profiles$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Profiles$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Profiles$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Profiles$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudprofiler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Profiles$Create { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Parent project to create the profile in. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreateProfileRequest; + } + export interface Params$Resource$Projects$Profiles$Createoffline { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Parent project to create the profile in. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Profile; + } + export interface Params$Resource$Projects$Profiles$Patch { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Output only. Opaque, server-assigned, unique ID for this profile. + */ + name?: string; + /** + * Field mask used to specify the fields to be overwritten. Currently only + * profile_bytes and labels fields are supported by UpdateProfile, so only + * those fields can be specified in the mask. When no mask is provided, all + * fields are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Profile; + } +} diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index 9b9355b30a7..27fc28e8cdf 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -160,7 +160,7 @@ export namespace cloudresourcemanager_v1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index ccf302d7226..ff0c37fb49a 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -154,7 +154,7 @@ export namespace cloudresourcemanager_v1beta1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index 3d12243f1da..c16d5983c7f 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -52,6 +52,7 @@ export namespace cloudresourcemanager_v2 { root = this; folders: Resource$Folders; + operations: Resource$Operations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this._options = options || {}; @@ -59,6 +60,7 @@ export namespace cloudresourcemanager_v2 { this.getRoot.bind(this); this.folders = new Resource$Folders(this); + this.operations = new Resource$Operations(this); } getRoot() { @@ -143,7 +145,7 @@ export namespace cloudresourcemanager_v2 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } @@ -1510,4 +1512,93 @@ export namespace cloudresourcemanager_v2 { */ requestBody?: Schema$UndeleteFolderRequest; } + + + export class Resource$Operations { + root: Cloudresourcemanager; + constructor(root: Cloudresourcemanager) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudresourcemanager.operations.get + * @desc Gets the latest state of a long-running operation. Clients can use + * this method to poll the operation result at intervals as recommended by + * the API service. + * @alias cloudresourcemanager.operations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Operations$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Operations$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Operations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Operations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudresourcemanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Operations$Get { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } } diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index 47b78aa0cb6..b0abb17dd3e 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -52,6 +52,7 @@ export namespace cloudresourcemanager_v2beta1 { root = this; folders: Resource$Folders; + operations: Resource$Operations; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this._options = options || {}; @@ -59,6 +60,7 @@ export namespace cloudresourcemanager_v2beta1 { this.getRoot.bind(this); this.folders = new Resource$Folders(this); + this.operations = new Resource$Operations(this); } getRoot() { @@ -143,7 +145,7 @@ export namespace cloudresourcemanager_v2beta1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } @@ -373,13 +375,12 @@ export namespace cloudresourcemanager_v2beta1 { * can be used along with the suffix wildcard symbol `*`. The displayName * field in a query expression should use escaped quotes for values that * include whitespace to prevent unexpected behavior. Some example queries - * are: |Query | Description| |----- | -----------| - * |displayName=Test*|Folders whose display name starts with - * "Test".| |lifecycleState=ACTIVE|Folders whose lifecycleState is - * ACTIVE.| |parent=folders/123|Folders whose parent is - * "folders/123".| |parent=folders/123 AND - * lifecycleState=ACTIVE|Active folders whose parent is - * "folders/123".| |displayName=\\"Test + * are: |Query | Description| |----- | -----------| |displayName=Test* | + * Folders whose display name starts with "Test".| + * |lifecycleState=ACTIVE | Folders whose lifecycleState is ACTIVE.| + * |parent=folders/123 | Folders whose parent is "folders/123".| + * |parent=folders/123 AND lifecycleState=ACTIVE | Active folders whose + * parent is "folders/123".| |displayName=\\"Test * String\\"|Folders whose display name includes both "Test" * and "String".| */ @@ -526,11 +527,11 @@ export namespace cloudresourcemanager_v2beta1 { * headroom when moving folders that contain deleted folders. + The addition * of the Folder must not cause the total number of Folders under its parent * to exceed 100. If the operation fails due to a folder constraint - * violation, a PreconditionFailure explaining the violation will be - * returned. If the failure occurs synchronously then the - * PreconditionFailure will be returned via the Status.details field and if - * it occurs asynchronously then the PreconditionFailure will be returned - * via the the Operation.error field. The caller must have + * violation, some errors may be returned by the CreateFolder request, with + * status code FAILED_PRECONDITION and an error description. Other folder + * constraint violations will be communicated in the Operation, with the + * specific PreconditionFailure returned via the details list in the + * Operation.error field. The caller must have * `resourcemanager.folders.create` permission on the identified parent. * @alias cloudresourcemanager.folders.create * @memberOf! () @@ -578,7 +579,7 @@ export namespace cloudresourcemanager_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/folders').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/folders').replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), @@ -647,7 +648,7 @@ export namespace cloudresourcemanager_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE' }, options), @@ -711,7 +712,7 @@ export namespace cloudresourcemanager_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), @@ -782,7 +783,7 @@ export namespace cloudresourcemanager_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+resource}:getIamPolicy') + url: (rootUrl + '/v2/{+resource}:getIamPolicy') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, @@ -856,7 +857,7 @@ export namespace cloudresourcemanager_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/folders').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/folders').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), @@ -934,8 +935,7 @@ export namespace cloudresourcemanager_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+name}:move') - .replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+name}:move').replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), @@ -1011,7 +1011,7 @@ export namespace cloudresourcemanager_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH' }, options), @@ -1081,7 +1081,7 @@ export namespace cloudresourcemanager_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/folders:search') + url: (rootUrl + '/v2/folders:search') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, @@ -1153,7 +1153,7 @@ export namespace cloudresourcemanager_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+resource}:setIamPolicy') + url: (rootUrl + '/v2/{+resource}:setIamPolicy') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, @@ -1231,7 +1231,7 @@ export namespace cloudresourcemanager_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+resource}:testIamPermissions') + url: (rootUrl + '/v2/{+resource}:testIamPermissions') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, @@ -1305,7 +1305,7 @@ export namespace cloudresourcemanager_v2beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2beta1/{+name}:undelete') + url: (rootUrl + '/v2/{+name}:undelete') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, @@ -1512,4 +1512,93 @@ export namespace cloudresourcemanager_v2beta1 { */ requestBody?: Schema$UndeleteFolderRequest; } + + + export class Resource$Operations { + root: Cloudresourcemanager; + constructor(root: Cloudresourcemanager) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudresourcemanager.operations.get + * @desc Gets the latest state of a long-running operation. Clients can use + * this method to poll the operation result at intervals as recommended by + * the API service. + * @alias cloudresourcemanager.operations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Operations$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Operations$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Operations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Operations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudresourcemanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Operations$Get { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } } diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index 51b69dd3ffb..7626ced94bc 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -223,12 +223,9 @@ export namespace cloudtasks_v2beta2 { * default service when the task is attempted. If version is empty, then * the task will be sent to the version which is the default version when * the task is attempted. If instance is empty, then the task will be sent - * to an instance which is available when the task is attempted. When - * service is "default", version is "default", and - * instance is empty, host is shortened to just the - * `application_domain_name`. If service, version, or instance is invalid, - * then the task will be sent to the default version of the default service - * when the task is attempted. + * to an instance which is available when the task is attempted. If + * service, version, or instance is invalid, then the task will be sent to + * the default version of the default service when the task is attempted. */ host?: string; /** @@ -245,24 +242,22 @@ export namespace cloudtasks_v2beta2 { instance?: string; /** * App service. By default, the task is sent to the service which is the - * default service when the task is attempted ("default"). For - * some queues or tasks which were created using the App Engine Task Queue - * API, host is not parsable into service, version, and instance. For - * example, some tasks which were created using the App Engine SDK use a - * custom domain name; custom domains are not parsed by Cloud Tasks. If host - * is not parsable, then service, version, and instance are the empty - * string. + * default service when the task is attempted. For some queues or tasks + * which were created using the App Engine Task Queue API, host is not + * parsable into service, version, and instance. For example, some tasks + * which were created using the App Engine SDK use a custom domain name; + * custom domains are not parsed by Cloud Tasks. If host is not parsable, + * then service, version, and instance are the empty string. */ service?: string; /** * App version. By default, the task is sent to the version which is the - * default version when the task is attempted ("default"). For - * some queues or tasks which were created using the App Engine Task Queue - * API, host is not parsable into service, version, and instance. For - * example, some tasks which were created using the App Engine SDK use a - * custom domain name; custom domains are not parsed by Cloud Tasks. If host - * is not parsable, then service, version, and instance are the empty - * string. + * default version when the task is attempted. For some queues or tasks + * which were created using the App Engine Task Queue API, host is not + * parsable into service, version, and instance. For example, some tasks + * which were created using the App Engine SDK use a custom domain name; + * custom domains are not parsed by Cloud Tasks. If host is not parsable, + * then service, version, and instance are the empty string. */ version?: string; } @@ -612,8 +607,9 @@ export namespace cloudtasks_v2beta2 { */ appEngineHttpTarget?: Schema$AppEngineHttpTarget; /** - * The queue name. The queue name must have the following format: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * + * Caller-specified and required in CreateQueue, after which it becomes + * output only. The queue name. The queue name must have the following + * format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens * (-), colons (:), or periods (.). For more information, see * [Identifying @@ -622,8 +618,7 @@ export namespace cloudtasks_v2beta2 { * list of available locations can be obtained by calling ListLocations. * For more information, see https://cloud.google.com/about/locations/. * * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens - * (-). The maximum length is 100 characters. Caller-specified and required - * in CreateQueue, after which it becomes output only. + * (-). The maximum length is 100 characters. */ name?: string; /** @@ -920,7 +915,8 @@ export namespace cloudtasks_v2beta2 { */ createTime?: string; /** - * The task name. The task name must have the following format: + * Optionally caller-specified in CreateTask. The task name. The task name + * must have the following format: * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens * (-), colons (:), or periods (.). For more information, see @@ -932,8 +928,7 @@ export namespace cloudtasks_v2beta2 { * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens * (-). The maximum length is 100 characters. * `TASK_ID` can contain only * letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). - * The maximum length is 500 characters. Optionally caller-specified in - * CreateTask. + * The maximum length is 500 characters. */ name?: string; /** @@ -2068,7 +2063,7 @@ export namespace cloudtasks_v2beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. Caller-specified and required in CreateQueue, after which it becomes output only. + * @param {string} params.name Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * @param {string=} params.updateMask A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated. * @param {().Queue} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2890,8 +2885,9 @@ export namespace cloudtasks_v2beta2 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The queue name. The queue name must have the following format: - * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * + * Caller-specified and required in CreateQueue, after which it becomes + * output only. The queue name. The queue name must have the following + * format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens * (-), colons (:), or periods (.). For more information, see * [Identifying @@ -2900,8 +2896,7 @@ export namespace cloudtasks_v2beta2 { * of available locations can be obtained by calling ListLocations. For * more information, see https://cloud.google.com/about/locations/. * * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens - * (-). The maximum length is 100 characters. Caller-specified and required - * in CreateQueue, after which it becomes output only. + * (-). The maximum length is 100 characters. */ name?: string; /** @@ -3802,7 +3797,6 @@ export namespace cloudtasks_v2beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.orderBy Sort order used for the query. The only fields supported for sorting are `schedule_time` and `pull_message.tag`. All results will be returned in approximately ascending order. The default ordering is by `schedule_time`. * @param {integer=} params.pageSize Requested page size. Fewer tasks than requested might be returned. The maximum page size is 1000. If unspecified, the page size will be the maximum. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. * @param {string=} params.pageToken A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours. * @param {string} params.parent Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` @@ -4241,13 +4235,6 @@ export namespace cloudtasks_v2beta2 { */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - /** - * Sort order used for the query. The only fields supported for sorting are - * `schedule_time` and `pull_message.tag`. All results will be returned in - * approximately ascending order. The default ordering is by - * `schedule_time`. - */ - orderBy?: string; /** * Requested page size. Fewer tasks than requested might be returned. The * maximum page size is 1000. If unspecified, the page size will be the diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index 8466d1f1fd6..62044ea809b 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -182,7 +182,7 @@ export namespace composer_v1beta1 { */ export interface Schema$NodeConfig { /** - * Optional. The disk size in GB used for node VMs. Minimum size is 10GB. If + * Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If * unspecified, defaults to 100GB. Cannot be updated. */ diskSizeGb?: number; @@ -232,9 +232,9 @@ export namespace composer_v1beta1 { network?: string; /** * Optional. The set of Google API scopes to be made available on all node - * VMs. If `oauth_scopes` is empty, defaults to - * ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be - * updated. + * VMs. Defaults to + * ["https://www.googleapis.com/auth/cloud-platform"] and must be + * included in the list of specified scopes. Cannot be updated. */ oauthScopes?: string[]; /** @@ -762,7 +762,7 @@ export namespace composer_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.name The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" - * @param {string=} params.updateMask Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of argparse, the `updateMask` parameter would include the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.argparse". The included patch environment would specify the scikit-learn version as follows: { "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn and argparse will be unaffected. Only one update type may be included in a single request's `updateMask`. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows: { "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } } Note that in the above example, any existing labels that are not included in the `updateMask` will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the `updateMask`. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the `updateMask` would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following: { "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } } Note: Only the following fields can be updated:
Mask Purpose
config.softwareConfig.pypiPackages Replace all custom custom PyPI packages. If a replacement package map is not included in `environment`, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.
config.softwareConfig.pypiPackages.packagename Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in `updateMask`, and omit the mapping for it in `environment.config.softwareConfig.pypiPackages`. It is an error to provide both a mask of this form and the "config.softwareConfig.pypiPackages" mask.
labels Replace all environment labels. If a replacement labels map is not included in `environment`, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.
labels.labelName Set the label named labelName, while preserving other labels. To delete the label, include it in `updateMask` and omit its mapping in `environment.labels`. It is an error to provide both a mask of this form and the "labels" mask.
config.nodeCount Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the `config.nodeCount` field.
config.softwareConfig.airflowConfigOverrides Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in `environment`, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.
config.softwareConfig.properties.section-name Override the Apache Airflow property name in the section named section, preserving other properties. To delete the property override, include it in `updateMask` and omit its mapping in `environment.config.softwareConfig.properties`. It is an error to provide both a mask of this form and the "config.softwareConfig.properties" mask.
config.softwareConfig.envVariables Replace all environment variables. If a replacement environment variable map is not included in `environment`, all custom environment variables are cleared. It is an error to provide both this mask and a mask specifying one or more individual environment variables.
+ * @param {string=} params.updateMask Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of argparse, the `updateMask` parameter would include the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.argparse". The included patch environment would specify the scikit-learn version as follows: { "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn and argparse will be unaffected. Only one update type may be included in a single request's `updateMask`. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows: { "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } } Note that in the above example, any existing labels that are not included in the `updateMask` will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the `updateMask`. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the `updateMask` would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following: { "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } } Note: Only the following fields can be updated:
Mask Purpose
config.softwareConfig.pypiPackages Replace all custom custom PyPI packages. If a replacement package map is not included in `environment`, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package.
config.softwareConfig.pypiPackages.packagename Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in `updateMask`, and omit the mapping for it in `environment.config.softwareConfig.pypiPackages`. It is an error to provide both a mask of this form and the "config.softwareConfig.pypiPackages" mask.
labels Replace all environment labels. If a replacement labels map is not included in `environment`, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels.
labels.labelName Set the label named labelName, while preserving other labels. To delete the label, include it in `updateMask` and omit its mapping in `environment.labels`. It is an error to provide both a mask of this form and the "labels" mask.
config.nodeCount Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the `config.nodeCount` field.
config.softwareConfig.airflowConfigOverrides Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in `environment`, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides.
config.softwareConfig.airflowConfigOverrides.section-name Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in `updateMask` and omit its mapping in `environment.config.softwareConfig.airflowConfigOverrides`. It is an error to provide both a mask of this form and the "config.softwareConfig.airflowConfigOverrides" mask.
config.softwareConfig.envVariables Replace all environment variables. If a replacement environment variable map is not included in `environment`, all custom environment variables are cleared. It is an error to provide both this mask and a mask specifying one or more individual environment variables.
* @param {().Environment} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -957,13 +957,14 @@ export namespace composer_v1beta1 { * is not included in `environment`, all config overrides are cleared. It * is an error to provide both this mask and a mask specifying one or more * individual config overrides. - * config.softwareConfig.properties.section-name - * Override the Apache Airflow property name in - * the section named section, preserving other properties. To - * delete the property override, include it in `updateMask` and omit its - * mapping in `environment.config.softwareConfig.properties`. It is an + * config.softwareConfig.airflowConfigOverrides.section-name + * Override the Apache Airflow config property + * name in the section named section, preserving + * other properties. To delete the property override, include it in + * `updateMask` and omit its mapping in + * `environment.config.softwareConfig.airflowConfigOverrides`. It is an * error to provide both a mask of this form and the - * "config.softwareConfig.properties" mask. + * "config.softwareConfig.airflowConfigOverrides" mask. * config.softwareConfig.envVariables Replace all environment * variables. If a replacement environment variable map is not included in * `environment`, all custom environment variables are cleared. It is an diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index cd5f137a754..882ee707a5f 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -94,7 +94,9 @@ export namespace compute_alpha { regionInstanceGroups: Resource$Regioninstancegroups; regionOperations: Resource$Regionoperations; regions: Resource$Regions; + regionSslCertificates: Resource$Regionsslcertificates; regionTargetHttpProxies: Resource$Regiontargethttpproxies; + regionTargetHttpsProxies: Resource$Regiontargethttpsproxies; regionUrlMaps: Resource$Regionurlmaps; resourcePolicies: Resource$Resourcepolicies; routers: Resource$Routers; @@ -167,7 +169,10 @@ export namespace compute_alpha { this.regionInstanceGroups = new Resource$Regioninstancegroups(this); this.regionOperations = new Resource$Regionoperations(this); this.regions = new Resource$Regions(this); + this.regionSslCertificates = new Resource$Regionsslcertificates(this); this.regionTargetHttpProxies = new Resource$Regiontargethttpproxies(this); + this.regionTargetHttpsProxies = + new Resource$Regiontargethttpsproxies(this); this.regionUrlMaps = new Resource$Regionurlmaps(this); this.resourcePolicies = new Resource$Resourcepolicies(this); this.routers = new Resource$Routers(this); @@ -723,7 +728,8 @@ export namespace compute_alpha { export interface Schema$AttachedDiskInitializeParams { /** * Specifies the disk name. If not specified, the default is to use the name - * of the instance. + * of the instance. If the disk with the instance name exists already in the + * given zone/region, a new name will be automatically generated. */ diskName?: string; /** @@ -787,6 +793,10 @@ export namespace compute_alpha { * this field will not be set. */ sourceSnapshot?: string; + /** + * The customer-supplied encryption key of the source snapshot. + */ + sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; } /** * Specifies the audit configuration for a service. The configuration @@ -1314,7 +1324,7 @@ export namespace compute_alpha { */ bucketName?: string; /** - * Cloud CDN Coniguration for this BackendBucket. + * Cloud CDN configuration for this BackendBucket. */ cdnPolicy?: Schema$BackendBucketCdnPolicy; /** @@ -1358,18 +1368,17 @@ export namespace compute_alpha { */ export interface Schema$BackendBucketCdnPolicy { /** - * Number of seconds up to which the response to a signed URL request will - * be cached in the CDN. After this time period, the Signed URL will be - * revalidated before being served. Defaults to 1hr (3600s). If this field - * is set, Cloud CDN will internally act as though all responses from this - * bucket had a ?Cache-Control: public, max-age=[TTL]? header, regardless of - * any existing Cache-Control header. The actual headers served in responses - * will not be altered. + * Maximum number of seconds the response to a signed URL request will be + * considered fresh. After this time period, the response will be + * revalidated before being served. Defaults to 1hr (3600s). When serving + * responses to signed URL requests, Cloud CDN will internally behave as + * though all responses from this backend had a ?Cache-Control: public, + * max-age=[TTL]? header, regardless of any existing Cache-Control header. + * The actual headers served in responses will not be altered. */ signedUrlCacheMaxAgeSec?: string; /** - * [Output Only] Names of the keys currently configured for Cloud CDN Signed - * URL on this backend bucket. + * [Output Only] Names of the keys for signing request URLs. */ signedUrlKeyNames?: string[]; } @@ -1462,7 +1471,8 @@ export namespace compute_alpha { * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. This field will be * ignored when inserting a BackendService. An up-to-date fingerprint must - * be provided in order to update the BackendService. + * be provided in order to update the BackendService. To see the latest + * fingerprint, make a get() request to retrieve a BackendService. */ fingerprint?: string; /** @@ -1613,18 +1623,17 @@ export namespace compute_alpha { */ cacheKeyPolicy?: Schema$CacheKeyPolicy; /** - * Number of seconds up to which the response to a signed URL request will - * be cached in the CDN. After this time period, the Signed URL will be - * revalidated before being served. Defaults to 1hr (3600s). If this field - * is set, Cloud CDN will internally act as though all responses from this - * backend had a ?Cache-Control: public, max-age=[TTL]? header, regardless - * of any existing Cache-Control header. The actual headers served in - * responses will not be altered. + * Maximum number of seconds the response to a signed URL request will be + * considered fresh. After this time period, the response will be + * revalidated before being served. Defaults to 1hr (3600s). When serving + * responses to signed URL requests, Cloud CDN will internally behave as + * though all responses from this backend had a ?Cache-Control: public, + * max-age=[TTL]? header, regardless of any existing Cache-Control header. + * The actual headers served in responses will not be altered. */ signedUrlCacheMaxAgeSec?: string; /** - * [Output Only] Names of the keys currently configured for Cloud CDN Signed - * URL on this backend service. + * [Output Only] Names of the keys for signing request URLs. */ signedUrlKeyNames?: string[]; } @@ -1765,10 +1774,10 @@ export namespace compute_alpha { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. This - * field is only visible as GOOGLE_INTERNAL or CONDITION_TRUSTED_TESTER. + * Unimplemented. The condition that is associated with this binding. NOTE: + * an unsatisfied condition will not allow user access via current binding. + * Different bindings, including their conditions, are examined + * independently. */ condition?: Schema$Expr; /** @@ -2593,12 +2602,15 @@ export namespace compute_alpha { warning?: any; } export interface Schema$DistributionPolicy { + /** + * Zones where the regional managed instance group will create and manage + * instances. + */ zones?: Schema$DistributionPolicyZoneConfiguration[]; } export interface Schema$DistributionPolicyZoneConfiguration { /** - * URL of the zone where managed instance group is spawning instances (for - * regional resources). Zone has to belong to the region where managed + * The URL of the zone. The zone must exist in the region where the managed * instance group is located. */ zone?: string; @@ -2860,7 +2872,7 @@ export namespace compute_alpha { */ allPorts?: boolean; /** - * This field is not used for external load balancing. For internal load + * This field is only used for INTERNAL load balancing. For internal load * balancing, this field identifies the BackendService resource to receive * the matched traffic. */ @@ -2898,12 +2910,14 @@ export namespace compute_alpha { * field is empty, an ephemeral IPv4 address from the same scope (global or * regional) will be assigned. A regional forwarding rule supports IPv4 * only. A global forwarding rule supports either IPv4 or IPv6. When the - * load balancing scheme is INTERNAL, this can only be an RFC 1918 IP - * address belonging to the network/subnet configured for the forwarding - * rule. By default, if this field is empty, an ephemeral internal IP - * address will be automatically allocated from the IP range of the subnet - * or network configured for this forwarding rule. An address can be - * specified either by a literal IP address or a URL reference to an + * load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL + * reference to an existing Address resource ( internal regional static IP + * address). When the load balancing scheme is INTERNAL, this can only be + * an RFC 1918 IP address belonging to the network/subnet configured for the + * forwarding rule. By default, if this field is empty, an ephemeral + * internal IP address will be automatically allocated from the IP range of + * the subnet or network configured for this forwarding rule. An address + * can be specified either by a literal IP address or a URL reference to an * existing Address resource. The following examples are all valid: - * 100.1.2.3 - * https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address @@ -2914,13 +2928,14 @@ export namespace compute_alpha { /** * The IP protocol to which this rule applies. Valid options are TCP, UDP, * ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only - * TCP and UDP are valid. + * TCP and UDP are valid. When the load balancing scheme is + * INTERNAL_SELF_MANAGED, only TCPis valid. */ IPProtocol?: string; /** * The IP Version that will be used by this forwarding rule. Valid options - * are IPV4 or IPV6. This can only be specified for a global forwarding - * rule. + * are IPV4 or IPV6. This can only be specified for an external global + * forwarding rule. */ ipVersion?: string; /** @@ -2946,10 +2961,12 @@ export namespace compute_alpha { labels?: any; /** * This signifies what the ForwardingRule will be used for and can only take - * the following values: INTERNAL, EXTERNAL The value of INTERNAL means that - * this will be used for Internal Network Load Balancing (TCP, UDP). The - * value of EXTERNAL means that this will be used for External Load - * Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) + * the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The + * value of INTERNAL means that this will be used for Internal Network Load + * Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this + * will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means + * that this will be used for External Load Balancing (HTTP(S) LB, External + * TCP/UDP LB, SSL Proxy) */ loadBalancingScheme?: string; /** @@ -2963,10 +2980,10 @@ export namespace compute_alpha { */ name?: string; /** - * This field is not used for external load balancing. For internal load - * balancing, this field identifies the network that the load balanced IP - * should belong to for this Forwarding Rule. If this field is not - * specified, the default network will be used. + * This field is not used for external load balancing. For INTERNAL and + * INTERNAL_SELF_MANAGED load balancing, this field identifies the network + * that the load balanced IP should belong to for this Forwarding Rule. If + * this field is not specified, the default network will be used. */ network?: string; /** @@ -3028,7 +3045,7 @@ export namespace compute_alpha { */ serviceName?: string; /** - * This field is not used for external load balancing. For internal load + * This field is only used for INTERNAL load balancing. For internal load * balancing, this field identifies the subnetwork that the load balanced IP * should belong to for this Forwarding Rule. If the network specified is * in auto subnet mode, this field is optional. However, if the network is @@ -3040,7 +3057,8 @@ export namespace compute_alpha { * regional forwarding rules, this target must live in the same region as * the forwarding rule. For global forwarding rules, this target must be a * global load balancing resource. The forwarded traffic must be of a type - * appropriate to the target object. + * appropriate to the target object. For INTERNAL_SELF_MANAGED" load + * balancing, only HTTP and HTTPS targets are valid. */ target?: string; } @@ -3900,51 +3918,6 @@ export namespace compute_alpha { */ warning?: any; } - export interface Schema$HTTPSHealthCheck { - /** - * The value of the host header in the HTTPS health check request. If left - * empty (default value), the IP on behalf of which this health check is - * performed will be used. - */ - host?: string; - /** - * The TCP port number for the health check request. The default value is - * 443. Valid values are 1 through 65535. - */ - port?: number; - /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. - */ - portName?: string; - /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, HTTPS health check follows - * behavior specified in port and portName fields. - */ - portSpecification?: string; - /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. - */ - proxyHeader?: string; - /** - * The request path of the HTTPS health check request. The default value is - * /. - */ - requestPath?: string; - /** - * The string to match anywhere in the first 1024 bytes of the response - * body. If left empty (the default value), the status code determines - * health. The response data can only be ASCII. - */ - response?: string; - } /** * An HttpsHealthCheck resource. This resource defines a template for how * individual instances should be checked for health, via HTTPS. @@ -4020,220 +3993,265 @@ export namespace compute_alpha { */ unhealthyThreshold?: number; } - /** - * Contains a list of HttpsHealthCheck resources. - */ - export interface Schema$HttpsHealthCheckList { - /** - * [Output Only] Unique identifier for the resource; defined by the server. - */ - id?: string; - /** - * A list of HttpsHealthCheck resources. - */ - items?: Schema$HttpsHealthCheck[]; - /** - * Type of resource. - */ - kind?: string; - /** - * [Output Only] This token allows you to get the next page of results for - * list requests. If the number of results is larger than maxResults, use - * the nextPageToken as a value for the query parameter pageToken in the - * next list request. Subsequent list requests will have their own - * nextPageToken to continue paging through the results. - */ - nextPageToken?: string; - /** - * [Output Only] Server-defined URL for this resource. - */ - selfLink?: string; - /** - * [Output Only] Informational warning message. - */ - warning?: any; - } - /** - * An Image resource. (== resource_for beta.images ==) (== resource_for - * v1.images ==) - */ - export interface Schema$Image { - /** - * Size of the image tar.gz archive stored in Google Cloud Storage (in - * bytes). - */ - archiveSizeBytes?: string; - /** - * [Output Only] Creation timestamp in RFC3339 text format. - */ - creationTimestamp?: string; - /** - * The deprecation status associated with this image. - */ - deprecated?: Schema$DeprecationStatus; - /** - * An optional description of this resource. Provide this property when you - * create the resource. - */ - description?: string; - /** - * Size of the image when restored onto a persistent disk (in GB). - */ - diskSizeGb?: string; - /** - * The name of the image family to which this image belongs. You can create - * disks by specifying an image family instead of a specific image name. The - * image family always returns its latest image that is not deprecated. The - * name of the image family must comply with RFC1035. - */ - family?: string; - /** - * A list of features to enable on the guest operating system. Applicable - * only for bootable images. Read Enabling guest operating system features - * to see a list of available options. - */ - guestOsFeatures?: Schema$GuestOsFeature[]; - /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. - */ - id?: string; - /** - * Encrypts the image using a customer-supplied encryption key. After you - * encrypt an image with a customer-supplied key, you must provide the same - * key if you use the image later (e.g. to create a disk from the image). - * Customer-supplied encryption keys do not protect access to metadata of - * the disk. If you do not provide an encryption key when creating the - * image, then the disk will be encrypted using an automatically generated - * key and you do not need to provide a key to use the image later. - */ - imageEncryptionKey?: Schema$CustomerEncryptionKey; - /** - * [Output Only] Type of the resource. Always compute#image for images. - */ - kind?: string; - /** - * A fingerprint for the labels being applied to this image, which is - * essentially a hash of the labels used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels. To see - * the latest fingerprint, make a get() request to retrieve an image. - */ - labelFingerprint?: string; - /** - * Labels to apply to this image. These can be later modified by the - * setLabels method. - */ - labels?: any; - /** - * Integer license codes indicating which licenses are attached to this - * image. - */ - licenseCodes?: string[]; - /** - * Any applicable license URI. - */ - licenses?: string[]; - /** - * Name of the resource; provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. - */ - name?: string; - /** - * The parameters of the raw disk image. - */ - rawDisk?: any; - /** - * [Output Only] Server-defined URL for the resource. - */ - selfLink?: string; - /** - * URL of the source disk used to create this image. This can be a full or - * valid partial URL. You must provide either this property or the - * rawDisk.source property but not both to create an image. For example, the - * following are valid values: - - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - * - projects/project/zones/zone/disks/disk - zones/zone/disks/disk - */ - sourceDisk?: string; - /** - * The customer-supplied encryption key of the source disk. Required if the - * source disk is protected by a customer-supplied encryption key. - */ - sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; - /** - * The ID value of the disk used to create this image. This value may be - * used to determine whether the image was taken from the current or a - * previous instance of a given disk name. - */ - sourceDiskId?: string; - /** - * URL of the source image used to create this image. This can be a full or - * valid partial URL. You must provide exactly one of: - this property, or - * - the rawDisk.source property, or - the sourceDisk property in order - * to create an image. - */ - sourceImage?: string; + export interface Schema$HTTPSHealthCheck { /** - * The customer-supplied encryption key of the source image. Required if the - * source image is protected by a customer-supplied encryption key. + * The value of the host header in the HTTPS health check request. If left + * empty (default value), the IP on behalf of which this health check is + * performed will be used. */ - sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; + host?: string; /** - * [Output Only] The ID value of the image used to create this image. This - * value may be used to determine whether the image was taken from the - * current or a previous instance of a given image name. + * The TCP port number for the health check request. The default value is + * 443. Valid values are 1 through 65535. */ - sourceImageId?: string; + port?: number; /** - * URL of the source snapshot used to create this image. This can be a full - * or valid partial URL. You must provide exactly one of: - this property, - * or - the sourceImage property, or - the rawDisk.source property, or - * - the sourceDisk property in order to create an image. + * Port name as defined in InstanceGroup#NamedPort#name. If both port and + * port_name are defined, port takes precedence. */ - sourceSnapshot?: string; + portName?: string; /** - * The customer-supplied encryption key of the source snapshot. Required if - * the source snapshot is protected by a customer-supplied encryption key. + * Specifies how port is selected for health checking, can be one of + * following values: USE_FIXED_PORT: The port number in port is used for + * health checking. USE_NAMED_PORT: The portName is used for health + * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified + * for each network endpoint is used for health checking. For other + * backends, the port or named port specified in the Backend Service is used + * for health checking. If not specified, HTTPS health check follows + * behavior specified in port and portName fields. */ - sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; + portSpecification?: string; /** - * [Output Only] The ID value of the snapshot used to create this image. - * This value may be used to determine whether the snapshot was taken from - * the current or a previous instance of a given snapshot name. + * Specifies the type of proxy header to append before sending data to the + * backend, either NONE or PROXY_V1. The default is NONE. */ - sourceSnapshotId?: string; + proxyHeader?: string; /** - * The type of the image used to create this disk. The default and only - * value is RAW + * The request path of the HTTPS health check request. The default value is + * /. */ - sourceType?: string; + requestPath?: string; /** - * [Output Only] The status of the image. An image can be used to create - * other resources, such as instances, only after the image has been - * successfully created and the status is set to READY. Possible values are - * FAILED, PENDING, or READY. + * The string to match anywhere in the first 1024 bytes of the response + * body. If left empty (the default value), the status code determines + * health. The response data can only be ASCII. */ - status?: string; + response?: string; } /** - * Contains a list of images. + * Contains a list of HttpsHealthCheck resources. */ - export interface Schema$ImageList { + export interface Schema$HttpsHealthCheckList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ id?: string; /** - * A list of Image resources. + * A list of HttpsHealthCheck resources. */ - items?: Schema$Image[]; + items?: Schema$HttpsHealthCheck[]; + /** + * Type of resource. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } + /** + * An Image resource. (== resource_for beta.images ==) (== resource_for + * v1.images ==) + */ + export interface Schema$Image { + /** + * Size of the image tar.gz archive stored in Google Cloud Storage (in + * bytes). + */ + archiveSizeBytes?: string; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string; + /** + * The deprecation status associated with this image. + */ + deprecated?: Schema$DeprecationStatus; + /** + * An optional description of this resource. Provide this property when you + * create the resource. + */ + description?: string; + /** + * Size of the image when restored onto a persistent disk (in GB). + */ + diskSizeGb?: string; + /** + * The name of the image family to which this image belongs. You can create + * disks by specifying an image family instead of a specific image name. The + * image family always returns its latest image that is not deprecated. The + * name of the image family must comply with RFC1035. + */ + family?: string; + /** + * A list of features to enable on the guest operating system. Applicable + * only for bootable images. Read Enabling guest operating system features + * to see a list of available options. + */ + guestOsFeatures?: Schema$GuestOsFeature[]; + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id?: string; + /** + * Encrypts the image using a customer-supplied encryption key. After you + * encrypt an image with a customer-supplied key, you must provide the same + * key if you use the image later (e.g. to create a disk from the image). + * Customer-supplied encryption keys do not protect access to metadata of + * the disk. If you do not provide an encryption key when creating the + * image, then the disk will be encrypted using an automatically generated + * key and you do not need to provide a key to use the image later. + */ + imageEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] Type of the resource. Always compute#image for images. + */ + kind?: string; + /** + * A fingerprint for the labels being applied to this image, which is + * essentially a hash of the labels used for optimistic locking. The + * fingerprint is initially generated by Compute Engine and changes after + * every request to modify or update labels. You must always provide an + * up-to-date fingerprint hash in order to update or change labels. To see + * the latest fingerprint, make a get() request to retrieve an image. + */ + labelFingerprint?: string; + /** + * Labels to apply to this image. These can be later modified by the + * setLabels method. + */ + labels?: any; + /** + * Integer license codes indicating which licenses are attached to this + * image. + */ + licenseCodes?: string[]; + /** + * Any applicable license URI. + */ + licenses?: string[]; + /** + * Name of the resource; provided by the client when the resource is + * created. The name must be 1-63 characters long, and comply with RFC1035. + * Specifically, the name must be 1-63 characters long and match the regular + * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character + * must be a lowercase letter, and all following characters must be a dash, + * lowercase letter, or digit, except the last character, which cannot be a + * dash. + */ + name?: string; + /** + * The parameters of the raw disk image. + */ + rawDisk?: any; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string; + /** + * URL of the source disk used to create this image. This can be a full or + * valid partial URL. You must provide either this property or the + * rawDisk.source property but not both to create an image. For example, the + * following are valid values: - + * https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk + * - projects/project/zones/zone/disks/disk - zones/zone/disks/disk + */ + sourceDisk?: string; + /** + * The customer-supplied encryption key of the source disk. Required if the + * source disk is protected by a customer-supplied encryption key. + */ + sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The ID value of the disk used to create this image. This + * value may be used to determine whether the image was taken from the + * current or a previous instance of a given disk name. + */ + sourceDiskId?: string; + /** + * URL of the source image used to create this image. This can be a full or + * valid partial URL. You must provide exactly one of: - this property, or + * - the rawDisk.source property, or - the sourceDisk property in order + * to create an image. + */ + sourceImage?: string; + /** + * The customer-supplied encryption key of the source image. Required if the + * source image is protected by a customer-supplied encryption key. + */ + sourceImageEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The ID value of the image used to create this image. This + * value may be used to determine whether the image was taken from the + * current or a previous instance of a given image name. + */ + sourceImageId?: string; + /** + * URL of the source snapshot used to create this image. This can be a full + * or valid partial URL. You must provide exactly one of: - this property, + * or - the sourceImage property, or - the rawDisk.source property, or + * - the sourceDisk property in order to create an image. + */ + sourceSnapshot?: string; + /** + * The customer-supplied encryption key of the source snapshot. Required if + * the source snapshot is protected by a customer-supplied encryption key. + */ + sourceSnapshotEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * [Output Only] The ID value of the snapshot used to create this image. + * This value may be used to determine whether the snapshot was taken from + * the current or a previous instance of a given snapshot name. + */ + sourceSnapshotId?: string; + /** + * The type of the image used to create this disk. The default and only + * value is RAW + */ + sourceType?: string; + /** + * [Output Only] The status of the image. An image can be used to create + * other resources, such as instances, only after the image has been + * successfully created and the status is set to READY. Possible values are + * FAILED, PENDING, or READY. + */ + status?: string; + } + /** + * Contains a list of images. + */ + export interface Schema$ImageList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of Image resources. + */ + items?: Schema$Image[]; /** * Type of resource. */ @@ -4625,7 +4643,6 @@ export namespace compute_alpha { * v1.regionInstanceGroupManagers ==) */ export interface Schema$InstanceGroupManager { - activities?: Schema$InstanceGroupManagerActivities; /** * The autohealing policy for this managed instance group. You can specify * only one value. @@ -4654,7 +4671,8 @@ export namespace compute_alpha { */ description?: string; /** - * Policy valid only for regional managed instance groups. + * Policy specifying intended distribution of instances in regional managed + * instance group. */ distributionPolicy?: Schema$DistributionPolicy; /** @@ -4666,7 +4684,8 @@ export namespace compute_alpha { * Fingerprint of this resource. This field may be used in optimistic * locking. It will be ignored when inserting an InstanceGroupManager. An * up-to-date fingerprint must be provided in order to update the - * InstanceGroupManager. + * InstanceGroupManager. To see the latest fingerprint, make a get() + * request to retrieve an InstanceGroupManager. */ fingerprint?: string; /** @@ -4726,6 +4745,10 @@ export namespace compute_alpha { * Stateful configuration for this Instanced Group Manager */ statefulPolicy?: Schema$StatefulPolicy; + /** + * [Output Only] The status of this managed instance group. + */ + status?: Schema$InstanceGroupManagerStatus; /** * The URLs for all TargetPool resources to which instances in the * instanceGroup field are added. The target pools automatically apply to @@ -4818,15 +4841,6 @@ export namespace compute_alpha { */ verifying?: number; } - export interface Schema$InstanceGroupManagerActivities { - autohealing?: string; - autohealingHealthCheckBased?: string; - autoscalingDown?: string; - autoscalingUp?: string; - creatingInstances?: string; - deletingInstances?: string; - recreatingInstances?: string; - } export interface Schema$InstanceGroupManagerAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. @@ -4881,10 +4895,6 @@ export namespace compute_alpha { * default, a percent value of 100% is used. */ maxUnavailable?: Schema$FixedOrPercent; - /** - * Defines operating mode for this policy. - */ - mode?: string; } /** * [Output Only] A list of managed instance groups. @@ -5094,6 +5104,17 @@ export namespace compute_alpha { */ targetPools?: string[]; } + export interface Schema$InstanceGroupManagerStatus { + /** + * [Output Only] A bit indicating whether the managed instance group is in a + * stable state. A stable state means that: none of the instances in the + * managed instance group is currently undergoing any type of change (for + * example, creation, restart, or deletion); no future changes are scheduled + * for instances in the managed instance group; and the managed instance + * group itself is not being modified. + */ + isStable?: boolean; + } /** * InstanceGroupManagers.updatePerInstanceConfigs */ @@ -6062,6 +6083,77 @@ export namespace compute_alpha { */ googleDemarcId?: string; } + /** + * Diagnostics information about interconnect, contains detailed and current + * technical information about Google?s side of the connection. + */ + export interface Schema$InterconnectDiagnostics { + /** + * A list of InterconnectDiagnostics.ARPEntry objects, describing individual + * neighbors currently seen by the Google router in the ARP cache for the + * Interconnect. This will be empty when the Interconnect is not bundled. + */ + arpCaches?: Schema$InterconnectDiagnosticsARPEntry[]; + /** + * A list of InterconnectDiagnostics.LinkStatus objects, describing the + * status for each link on the Interconnect. + */ + links?: Schema$InterconnectDiagnosticsLinkStatus[]; + /** + * The MAC address of the Interconnect's bundle interface. + */ + macAddress?: string; + } + /** + * Describing the ARP neighbor entries seen on this link + */ + export interface Schema$InterconnectDiagnosticsARPEntry { + /** + * The IP address of this ARP neighbor. + */ + ipAddress?: string; + /** + * The MAC address of this ARP neighbor. + */ + macAddress?: string; + } + export interface Schema$InterconnectDiagnosticsLinkLACPStatus { + /** + * System ID of the port on Google?s side of the LACP exchange. + */ + googleSystemId?: string; + /** + * System ID of the port on the neighbor?s side of the LACP exchange. + */ + neighborSystemId?: string; + state?: string; + } + export interface Schema$InterconnectDiagnosticsLinkOpticalPower { + state?: string; + /** + * Value of the current optical power, read in dBm. + */ + value?: number; + } + export interface Schema$InterconnectDiagnosticsLinkStatus { + /** + * A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP + * neighbor entries seen on this link. This will be empty if the link is + * bundled + */ + arpCaches?: Schema$InterconnectDiagnosticsARPEntry[]; + /** + * The unique ID for this link assigned during turn up by Google. + */ + circuitId?: string; + /** + * The Demarc address assigned by Google and provided in the LoA. + */ + googleDemarc?: string; + lacpStatus?: Schema$InterconnectDiagnosticsLinkLACPStatus; + receivingOpticalPower?: Schema$InterconnectDiagnosticsLinkOpticalPower; + transmittingOpticalPower?: Schema$InterconnectDiagnosticsLinkOpticalPower; + } /** * Response to the list request, and contains a list of interconnects. */ @@ -6269,6 +6361,34 @@ export namespace compute_alpha { */ state?: string; } + /** + * Response for the InterconnectsGetDiagnosticsRequest. + */ + export interface Schema$InterconnectsGetDiagnosticsResponse { + result?: Schema$InterconnectDiagnostics; + } + export interface Schema$InternalIpAddress { + /** + * IP CIDR address or range. + */ + cidr?: string; + /** + * The owner of the internal IP address. + */ + owner?: string; + /** + * The purpose of the internal IP address if applicable. + */ + purpose?: string; + /** + * The region of the internal IP address if applicable. + */ + region?: string; + /** + * The type of the internal IP address. + */ + type?: string; + } export interface Schema$InternalIpOwner { /** * IP CIDR range being owned. @@ -6283,6 +6403,37 @@ export namespace compute_alpha { */ systemOwned?: boolean; } + export interface Schema$IpAddressesList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of InternalIpOwner resources. + */ + items?: Schema$InternalIpAddress[]; + /** + * [Output Only] Type of resource. Always compute#ipAddressesList for IP + * addresses lists. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } /** * Contains a list of IP owners. */ @@ -6791,7 +6942,9 @@ export namespace compute_alpha { * the metadata's contents and used for optimistic locking. The * fingerprint is initially generated by Compute Engine and changes after * every request to modify or update metadata. You must always provide an - * up-to-date fingerprint hash in order to update or change metadata. + * up-to-date fingerprint hash in order to update or change metadata. To + * see the latest fingerprint, make a get() request to retrieve the + * resource. */ fingerprint?: string; /** @@ -6906,9 +7059,9 @@ export namespace compute_alpha { export interface Schema$NetworkEndpoint { /** * The name for a specific VM instance that the IP address belongs to. This - * is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. - * The instance must be in the same zone of network endpoint group. The - * name must be 1-63 characters long, and comply with RFC1035. + * is required for network endpoints of type GCE_VM_IP_PORT. The instance + * must be in the same zone of network endpoint group. The name must be + * 1-63 characters long, and comply with RFC1035. */ instance?: string; /** @@ -6950,8 +7103,8 @@ export namespace compute_alpha { */ kind?: string; /** - * This field is only valid when the network endpoint group type is - * LOAD_BALANCING. + * This field is only valid when the network endpoint group is used for load + * balancing. */ loadBalancer?: Schema$NetworkEndpointGroupLbNetworkEndpointGroup; /** @@ -6965,8 +7118,8 @@ export namespace compute_alpha { */ name?: string; /** - * Type of network endpoints in this network endpoint group. Only supported - * values for LOAD_BALANCING are GCE_VM_IP or GCE_VM_IP_PORT. + * Type of network endpoints in this network endpoint group. Currently the + * only supported value is GCE_VM_IP_PORT. */ networkEndpointType?: string; /** @@ -7016,14 +7169,12 @@ export namespace compute_alpha { warning?: any; } /** - * Load balancing specific fields for network endpoint group of type - * LOAD_BALANCING. + * Load balancing specific fields for network endpoint group. */ export interface Schema$NetworkEndpointGroupLbNetworkEndpointGroup { /** * The default port used if the port number is not specified in the network - * endpoint. If the network endpoint type is GCE_VM_IP, this field must not - * be specified. + * endpoint. */ defaultPort?: number; /** @@ -7367,7 +7518,8 @@ export namespace compute_alpha { */ name?: string; /** - * [Output Only] A list of nodes in this node group. + * [Deprecated] Use nodeGroups.listNodes instead. [Output Only] A list of + * nodes in this node group. */ nodes?: Schema$NodeGroupNode[]; /** @@ -7378,6 +7530,10 @@ export namespace compute_alpha { * [Output Only] Server-defined URL for the resource. */ selfLink?: string; + /** + * [Output Only] The total number of nodes in the node group. + */ + size?: number; status?: string; /** * [Output Only] The name of the zone where the node group resides, such as @@ -7451,7 +7607,6 @@ export namespace compute_alpha { warning?: any; } export interface Schema$NodeGroupNode { - index?: number; /** * Instances scheduled on this node. */ @@ -7464,6 +7619,7 @@ export namespace compute_alpha { * The type of this node. */ nodeType?: string; + status?: string; } export interface Schema$NodeGroupsAddNodesRequest { /** @@ -7472,11 +7628,39 @@ export namespace compute_alpha { additionalNodeCount?: number; } export interface Schema$NodeGroupsDeleteNodesRequest { + nodes?: string[]; + } + export interface Schema$NodeGroupsListNodes { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; /** - * Indexes of the nodes to be deleted from the node group. + * A list of Node resources. */ - nodeIndexes?: number[]; - nodes?: string[]; + items?: Schema$NodeGroupNode[]; + /** + * [Output Only] The resource type, which is always + * compute.nodeGroupsListNodes for the list of nodes in the specified node + * group. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; } export interface Schema$NodeGroupsScopedList { /** @@ -8355,6 +8539,18 @@ export namespace compute_alpha { */ warning?: any; } + export interface Schema$RegionDisksAddResourcePoliciesRequest { + /** + * Resource policies to be added to this disk. + */ + resourcePolicies?: string[]; + } + export interface Schema$RegionDisksRemoveResourcePoliciesRequest { + /** + * Resource policies to be removed from this disk. + */ + resourcePolicies?: string[]; + } export interface Schema$RegionDisksResizeRequest { /** * The new size of the regional persistent disk, which is specified in GB. @@ -8703,6 +8899,14 @@ export namespace compute_alpha { */ policy?: Schema$Policy; } + export interface Schema$RegionTargetHttpsProxiesSetSslCertificatesRequest { + /** + * New set of SslCertificate resources to associate with this + * TargetHttpsProxy resource. Currently exactly one SslCertificate resource + * must be specified. + */ + sslCertificates?: string[]; + } export interface Schema$RegionUrlMapsValidateRequest { /** * Content of the UrlMap to be validated. @@ -8906,6 +9110,11 @@ export namespace compute_alpha { * the setLabels method. Label values may be empty. */ labels?: any; + /** + * GCS bucket storage location of the auto snapshot (regional or + * multi-regional). + */ + storageLocations?: string[]; } /** * Time window specified for daily operations. @@ -8946,11 +9155,6 @@ export namespace compute_alpha { startTime?: string; } export interface Schema$ResourcePolicyVmMaintenancePolicy { - /** - * A hint about the environment this VM belongs to (production vs - * develoment) - */ - maintenanceEnvironment?: string; /** * Maintenance windows that are applied to VMs covered by this policy. */ @@ -9503,7 +9707,7 @@ export namespace compute_alpha { * valid option with multiple values is: ["PRIMARY_IP_RANGE", * "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES] */ - sourceIpRangesToNats?: string[]; + sourceIpRangesToNat?: string[]; } export interface Schema$RoutersPreviewResponse { /** @@ -9719,7 +9923,8 @@ export namespace compute_alpha { } /** * A security policy is comprised of one or more rules. It can also be - * associated with one or more 'targets'. Next available tag: 11 + * associated with one or more 'targets'. Next available tag: 11 (== + * resource_for beta.securityPolicies ==) */ export interface Schema$SecurityPolicy { /** @@ -10208,6 +10413,11 @@ export namespace compute_alpha { * this field. */ privateKey?: string; + /** + * [Output Only] URL of the region where the regional SSL Certificate + * resides. This field is not applicable to global SSL Certificate. + */ + region?: string; /** * [Output only] Server-defined URL for the resource. */ @@ -10229,6 +10439,37 @@ export namespace compute_alpha { */ type?: string; } + export interface Schema$SslCertificateAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of SslCertificatesScopedList resources. + */ + items?: any; + /** + * [Output Only] Type of resource. Always + * compute#sslCertificateAggregatedList for lists of SSL Certificates. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } /** * Contains a list of SslCertificate resources. */ @@ -10297,6 +10538,17 @@ export namespace compute_alpha { */ privateKey?: string; } + export interface Schema$SslCertificatesScopedList { + /** + * List of SslCertificates contained in this scope. + */ + sslCertificates?: Schema$SslCertificate[]; + /** + * Informational warning which replaces the list of backend services when + * the list is empty. + */ + warning?: any; + } export interface Schema$SSLHealthCheck { /** * The TCP port number for the health check request. The default value is @@ -10402,7 +10654,8 @@ export namespace compute_alpha { * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. This field will be * ignored when inserting a SslPolicy. An up-to-date fingerprint must be - * provided in order to update the SslPolicy. + * provided in order to update the SslPolicy. To see the latest + * fingerprint, make a get() request to retrieve an SslPolicy. */ fingerprint?: string; /** @@ -10478,6 +10731,13 @@ export namespace compute_alpha { * resource_for v1.subnetworks ==) */ export interface Schema$Subnetwork { + /** + * Can only be specified if VPC flow logging for this subnetwork is enabled. + * Toggles the aggregation interval for collecting flow logs. Increasing the + * interval time will reduce the amount of generated flow logs for long + * lasting connections. Default is an interval of 5 seconds per connection. + */ + aggregationInterval?: string; /** * Whether this subnetwork can conflict with static routes. Setting this to * true allows this subnetwork's primary and secondary ranges to @@ -10516,9 +10776,18 @@ export namespace compute_alpha { * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. This field will be * ignored when inserting a Subnetwork. An up-to-date fingerprint must be - * provided in order to update the Subnetwork. + * provided in order to update the Subnetwork. To see the latest + * fingerprint, make a get() request to retrieve a Subnetwork. */ fingerprint?: string; + /** + * Can only be specified if VPC flow logging for this subnetwork is enabled. + * The value of the field must be in [0, 1]. Set the sampling rate of VPC + * flow logs within the subnetwork where 1.0 means all collected logs are + * reported and 0.0 means no logs are reported. Default is 0.5 which means + * half of all collected logs are reported. + */ + flowSampling?: number; /** * [Output Only] The gateway address for default routes to reach destination * addresses outside this subnetwork. @@ -10547,6 +10816,12 @@ export namespace compute_alpha { * Subnetwork resources. */ kind?: string; + /** + * Can only be specified if VPC flow logging for this subnetwork is enabled. + * Configures whether metadata fields should be added to the reported VPC + * flow logs. Default is INCLUDE_ALL_METADATA. + */ + metadata?: string; /** * The name of the resource, provided by the client when initially creating * the resource. The name must be 1-63 characters long, and comply with @@ -10602,6 +10877,15 @@ export namespace compute_alpha { * [Output Only] Server-defined URL for the resource. */ selfLink?: string; + /** + * [Output Only] The state of the subnetwork, which can be one of READY or + * DRAINING. A subnetwork that is READY is ready to be used. The state of + * DRAINING is only applicable to subnetworks that have the purpose set to + * INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load + * balancer are being drained. A subnetwork that is draining cannot be used + * or modified until it reaches a status of READY. + */ + state?: string; } export interface Schema$SubnetworkAggregatedList { /** @@ -10855,6 +11139,17 @@ export namespace compute_alpha { */ warning?: any; } + export interface Schema$TargetHttpsProxiesScopedList { + /** + * A list of TargetHttpsProxies contained in this scope. + */ + targetHttpsProxies?: Schema$TargetHttpsProxy[]; + /** + * Informational warning which replaces the list of backend services when + * the list is empty. + */ + warning?: any; + } export interface Schema$TargetHttpsProxiesSetQuicOverrideRequest { /** * QUIC policy for the TargetHttpsProxy resource. @@ -10914,6 +11209,11 @@ export namespace compute_alpha { * specifying this field is equivalent to specifying NONE. */ quicOverride?: string; + /** + * [Output Only] URL of the region where the regional TargetHttpsProxy + * resides. This field is not applicable to global TargetHttpsProxies. + */ + region?: string; /** * [Output Only] Server-defined URL for the resource. */ @@ -10939,6 +11239,37 @@ export namespace compute_alpha { */ urlMap?: string; } + export interface Schema$TargetHttpsProxyAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of TargetHttpsProxiesScopedList resources. + */ + items?: any; + /** + * [Output Only] Type of resource. Always + * compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } /** * Contains a list of TargetHttpsProxy resources. */ @@ -11569,7 +11900,7 @@ export namespace compute_alpha { * changes after every request to modify or update labels. You must always * provide an up-to-date fingerprint hash in order to update or change * labels. To see the latest fingerprint, make a get() request to retrieve - * an TargetVpnGateway. + * a TargetVpnGateway. */ labelFingerprint?: string; /** @@ -11797,7 +12128,8 @@ export namespace compute_alpha { * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. This field will be * ignored when inserting a UrlMap. An up-to-date fingerprint must be - * provided in order to update the UrlMap. + * provided in order to update the UrlMap. To see the latest fingerprint, + * make a get() request to retrieve a UrlMap. */ fingerprint?: string; /** @@ -11881,6 +12213,47 @@ export namespace compute_alpha { export interface Schema$UrlMapReference { urlMap?: string; } + export interface Schema$UrlMapsAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of UrlMapsScopedList resources. + */ + items?: any; + /** + * Type of resource. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } + export interface Schema$UrlMapsScopedList { + /** + * A list of UrlMaps contained in this scope. + */ + UrlMaps?: Schema$UrlMap[]; + /** + * Informational warning which replaces the list of backend services when + * the list is empty. + */ + warning?: any; + } export interface Schema$UrlMapsValidateRequest { /** * Content of the UrlMap to be validated. @@ -12022,6 +12395,78 @@ export namespace compute_alpha { */ reportNamePrefix?: string; } + /** + * Contain information of Nat mapping for a VM endpoint (i.e., NIC). + */ + export interface Schema$VmEndpointNatMappings { + /** + * Name of the VM instance which the endpoint belongs to + */ + instanceName?: string; + interfaceNatMappings?: Schema$VmEndpointNatMappingsInterfaceNatMappings[]; + } + /** + * Contain information of Nat mapping for an interface of this endpoint. + */ + export interface Schema$VmEndpointNatMappingsInterfaceNatMappings { + /** + * A list of all IP:port-range mappings assigned to this interface. These + * ranges are inclusive, that is, both the first and the last ports can be + * used for NAT. Example: ["2.2.2.2:12345-12355", + * "1.1.1.1:2234-2234"]. + */ + natIpPortRanges?: string[]; + /** + * Total number of ports across all NAT IPs allocated to this interface. It + * equals to the aggregated port number in the field nat_ip_port_ranges. + */ + numTotalNatPorts?: number; + /** + * Alias IP range for this interface endpoint. It will be a private (RFC + * 1918) IP range. Examples: "10.33.4.55/32", or + * "192.168.5.0/24". + */ + sourceAliasIpRange?: string; + /** + * Primary IP of the VM for this NIC. + */ + sourceVirtualIp?: string; + } + /** + * Contains a list of VmEndpointNatMappings. + */ + export interface Schema$VmEndpointNatMappingsList { + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id?: string; + /** + * [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList + * for lists of Nat mappings of VM endpoints. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] A list of Nat mapping information of VM endpoints. + */ + result?: Schema$VmEndpointNatMappings[]; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } /** * Represents a VPN gateway resource. */ @@ -14603,7 +15048,8 @@ export namespace compute_alpha { /** * compute.backendBuckets.addSignedUrlKey - * @desc Adds the given Signed URL Key to the backend bucket. + * @desc Adds a key for validating requests with signed URLs for this + * backend bucket. * @alias compute.backendBuckets.addSignedUrlKey * @memberOf! () * @@ -14746,7 +15192,8 @@ export namespace compute_alpha { /** * compute.backendBuckets.deleteSignedUrlKey - * @desc Deletes the given Signed URL Key from the backend bucket. + * @desc Deletes a key for validating requests with signed URLs for this + * backend bucket. * @alias compute.backendBuckets.deleteSignedUrlKey * @memberOf! () * @@ -15717,7 +16164,8 @@ export namespace compute_alpha { /** * compute.backendServices.addSignedUrlKey - * @desc Adds the given Signed URL Key to the specified backend service. + * @desc Adds a key for validating requests with signed URLs for this + * backend service. * @alias compute.backendServices.addSignedUrlKey * @memberOf! () * @@ -15942,8 +16390,8 @@ export namespace compute_alpha { /** * compute.backendServices.deleteSignedUrlKey - * @desc Deletes the given Signed URL Key from the specified backend - * service. + * @desc Deletes a key for validating requests with signed URLs for this + * backend service. * @alias compute.backendServices.deleteSignedUrlKey * @memberOf! () * @@ -27654,11 +28102,11 @@ export namespace compute_alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). * @param {string} params.instanceGroupManager The name of the managed instance group. - * @param {integer=} params.maxResults - * @param {string=} params.order_by - * @param {string=} params.pageToken + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {string} params.zone The name of the zone where the managed instance group is located. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -28941,7 +29389,22 @@ export namespace compute_alpha { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -28949,15 +29412,27 @@ export namespace compute_alpha { */ instanceGroupManager?: string; /** - * + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) */ maxResults?: number; /** - * + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. */ order_by?: string; /** - * + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -34912,6 +35387,76 @@ export namespace compute_alpha { } + /** + * compute.instanceTemplates.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no + * such policy or resource exists. + * @alias compute.instanceTemplates.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Instancetemplates$Getiampolicy, + options?: MethodOptions): AxiosPromise; + getIamPolicy( + params: Params$Resource$Instancetemplates$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Instancetemplates$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: Params$Resource$Instancetemplates$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Instancetemplates$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/global/instanceTemplates/{resource}/getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.instanceTemplates.insert * @desc Creates an instance template in the specified project using the @@ -35062,6 +35607,77 @@ export namespace compute_alpha { } + /** + * compute.instanceTemplates.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias compute.instanceTemplates.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {().GlobalSetPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Instancetemplates$Setiampolicy, + options?: MethodOptions): AxiosPromise; + setIamPolicy( + params: Params$Resource$Instancetemplates$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: Params$Resource$Instancetemplates$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: Params$Resource$Instancetemplates$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Instancetemplates$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/global/instanceTemplates/{resource}/setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.instanceTemplates.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. @@ -35178,6 +35794,21 @@ export namespace compute_alpha { */ project?: string; } + export interface Params$Resource$Instancetemplates$Getiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + } export interface Params$Resource$Instancetemplates$Insert { /** * Auth client or API Key for the request @@ -35261,6 +35892,26 @@ export namespace compute_alpha { */ project?: string; } + export interface Params$Resource$Instancetemplates$Setiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetPolicyRequest; + } export interface Params$Resource$Instancetemplates$Testiampermissions { /** * Auth client or API Key for the request @@ -36852,6 +37503,88 @@ export namespace compute_alpha { } + /** + * compute.interconnects.getDiagnostics + * @desc Returns the interconnectDiagnostics for the specified interconnect. + * @alias compute.interconnects.getDiagnostics + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.interconnect Name of the interconnect resource to query. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getDiagnostics( + params?: Params$Resource$Interconnects$Getdiagnostics, + options?: MethodOptions): + AxiosPromise; + getDiagnostics( + params: Params$Resource$Interconnects$Getdiagnostics, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + getDiagnostics( + params: Params$Resource$Interconnects$Getdiagnostics, + callback: + BodyResponseCallback): + void; + getDiagnostics( + callback: + BodyResponseCallback): + void; + getDiagnostics( + paramsOrCallback?: Params$Resource$Interconnects$Getdiagnostics| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Interconnects$Getdiagnostics; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$Getdiagnostics; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/global/interconnects/{interconnect}/getDiagnostics') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'interconnect'], + pathParams: ['interconnect', 'project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + /** * compute.interconnects.getIamPolicy * @desc Gets the access control policy for a resource. May be empty if no @@ -37398,6 +38131,21 @@ export namespace compute_alpha { */ project?: string; } + export interface Params$Resource$Interconnects$Getdiagnostics { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the interconnect resource to query. + */ + interconnect?: string; + /** + * Project ID for this request. + */ + project?: string; + } export interface Params$Resource$Interconnects$Getiampolicy { /** * Auth client or API Key for the request @@ -40442,6 +41190,82 @@ export namespace compute_alpha { } + /** + * compute.networks.listIpAddresses + * @desc Lists the internal IP addresses in the specified network. + * @alias compute.networks.listIpAddresses + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string} params.network Name of the network for this request. + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string=} params.types (Optional) types filter separate by comma, valid values are: SUBNETWORK, RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listIpAddresses( + params?: Params$Resource$Networks$Listipaddresses, + options?: MethodOptions): AxiosPromise; + listIpAddresses( + params: Params$Resource$Networks$Listipaddresses, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + listIpAddresses( + params: Params$Resource$Networks$Listipaddresses, + callback: BodyResponseCallback): void; + listIpAddresses(callback: BodyResponseCallback): + void; + listIpAddresses( + paramsOrCallback?: Params$Resource$Networks$Listipaddresses| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Networks$Listipaddresses; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networks$Listipaddresses; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/global/networks/{network}/listIpAddresses') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'network'], + pathParams: ['network', 'project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.networks.listIpOwners * @desc Lists the internal IP owners in the specified network. @@ -40969,6 +41793,69 @@ export namespace compute_alpha { */ project?: string; } + export interface Params$Resource$Networks$Listipaddresses { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Name of the network for this request. + */ + network?: string; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * (Optional) types filter separate by comma, valid values are: SUBNETWORK, + * RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED. + */ + types?: string; + } export interface Params$Resource$Networks$Listipowners { /** * Auth client or API Key for the request @@ -41250,7 +42137,8 @@ export namespace compute_alpha { /** * compute.nodeGroups.aggregatedList - * @desc Retrieves an aggregated list of node groups. + * @desc Retrieves an aggregated list of node groups. Note: use + * nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.aggregatedList * @memberOf! () * @@ -41469,7 +42357,8 @@ export namespace compute_alpha { /** * compute.nodeGroups.get * @desc Returns the specified NodeGroup. Get a list of available NodeGroups - * by making a list() request. + * by making a list() request. Note: the "nodes" field should not be used. + * Use nodeGroups.listNodes instead. * @alias compute.nodeGroups.get * @memberOf! () * @@ -41679,6 +42568,7 @@ export namespace compute_alpha { /** * compute.nodeGroups.list * @desc Retrieves a list of node groups available to the specified project. + * Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.list * @memberOf! () * @@ -41747,6 +42637,81 @@ export namespace compute_alpha { } + /** + * compute.nodeGroups.listNodes + * @desc Lists nodes in the node group. + * @alias compute.nodeGroups.listNodes + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string} params.nodeGroup Name of the NodeGroup resource whose nodes you want to list. + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listNodes( + params?: Params$Resource$Nodegroups$Listnodes, + options?: MethodOptions): AxiosPromise; + listNodes( + params: Params$Resource$Nodegroups$Listnodes, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + listNodes( + params: Params$Resource$Nodegroups$Listnodes, + callback: BodyResponseCallback): void; + listNodes(callback: BodyResponseCallback): void; + listNodes( + paramsOrCallback?: Params$Resource$Nodegroups$Listnodes| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Nodegroups$Listnodes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Listnodes; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.nodeGroups.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces @@ -42259,6 +43224,68 @@ export namespace compute_alpha { */ zone?: string; } + export interface Params$Resource$Nodegroups$Listnodes { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Name of the NodeGroup resource whose nodes you want to list. + */ + nodeGroup?: string; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } export interface Params$Resource$Nodegroups$Setiampolicy { /** * Auth client or API Key for the request @@ -43991,10 +45018,10 @@ export namespace compute_alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter - * @param {integer=} params.maxResults - * @param {string=} params.order_by - * @param {string=} params.pageToken + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -44066,10 +45093,10 @@ export namespace compute_alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter - * @param {integer=} params.maxResults - * @param {string=} params.order_by - * @param {string=} params.pageToken + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {().ProjectsListXpnHostsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -44698,19 +45725,46 @@ export namespace compute_alpha { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) */ maxResults?: number; /** - * + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. */ order_by?: string; /** - * + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -44725,19 +45779,46 @@ export namespace compute_alpha { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) */ maxResults?: number; /** - * + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. */ order_by?: string; /** - * + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -47142,6 +48223,81 @@ export namespace compute_alpha { } + /** + * compute.regionDisks.addResourcePolicies + * @desc Adds existing resource policies to a regional disk. You can only + * add one policy which will be applied to this disk for scheduling snapshot + * creation. + * @alias compute.regionDisks.addResourcePolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk The disk name for this request. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().RegionDisksAddResourcePoliciesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addResourcePolicies( + params?: Params$Resource$Regiondisks$Addresourcepolicies, + options?: MethodOptions): AxiosPromise; + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, + callback: BodyResponseCallback): void; + addResourcePolicies(callback: BodyResponseCallback): void; + addResourcePolicies( + paramsOrCallback?: Params$Resource$Regiondisks$Addresourcepolicies| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regiondisks$Addresourcepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Addresourcepolicies; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.regionDisks.createSnapshot * @desc Creates a snapshot of this regional disk. @@ -47500,6 +48656,80 @@ export namespace compute_alpha { } + /** + * compute.regionDisks.removeResourcePolicies + * @desc Removes resource policies from a regional disk. + * @alias compute.regionDisks.removeResourcePolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk The disk name for this request. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().RegionDisksRemoveResourcePoliciesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + removeResourcePolicies( + params?: Params$Resource$Regiondisks$Removeresourcepolicies, + options?: MethodOptions): AxiosPromise; + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, + callback: BodyResponseCallback): void; + removeResourcePolicies(callback: BodyResponseCallback): + void; + removeResourcePolicies( + paramsOrCallback?: Params$Resource$Regiondisks$Removeresourcepolicies| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regiondisks$Removeresourcepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Removeresourcepolicies; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.regionDisks.resize * @desc Resizes the specified regional persistent disk. @@ -47720,6 +48950,43 @@ export namespace compute_alpha { } } + export interface Params$Resource$Regiondisks$Addresourcepolicies { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The disk name for this request. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionDisksAddResourcePoliciesRequest; + } export interface Params$Resource$Regiondisks$Createsnapshot { /** * Auth client or API Key for the request @@ -47907,6 +49174,43 @@ export namespace compute_alpha { */ region?: string; } + export interface Params$Resource$Regiondisks$Removeresourcepolicies { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The disk name for this request. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionDisksRemoveResourcePoliciesRequest; + } export interface Params$Resource$Regiondisks$Resize { /** * Auth client or API Key for the request @@ -49659,11 +50963,11 @@ export namespace compute_alpha { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). * @param {string} params.instanceGroupManager The name of the managed instance group. - * @param {integer=} params.maxResults - * @param {string=} params.order_by - * @param {string=} params.pageToken + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -50482,6 +51786,7 @@ export namespace compute_alpha { * @param {string} params.instanceGroupManager The name of the managed instance group. It should conform to RFC1035. * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request, should conform to RFC1035. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). * @param {().RegionInstanceGroupManagerUpdateInstanceConfigReq} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -50821,7 +52126,22 @@ export namespace compute_alpha { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -50829,15 +52149,27 @@ export namespace compute_alpha { */ instanceGroupManager?: string; /** - * + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) */ maxResults?: number; /** - * + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. */ order_by?: string; /** - * + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -51211,6 +52543,19 @@ export namespace compute_alpha { * Name of the region scoping this request, should conform to RFC1035. */ region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; /** * Request body metadata @@ -52459,7 +53804,1207 @@ export namespace compute_alpha { } - export class Resource$Regiontargethttpproxies { + export class Resource$Regionsslcertificates { + root: Compute; + constructor(root: Compute) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * compute.regionSslCertificates.delete + * @desc Deletes the specified SslCertificate resource in the region. + * @alias compute.regionSslCertificates.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.sslCertificate Name of the SslCertificate resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regionsslcertificates$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Regionsslcertificates$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Regionsslcertificates$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Regionsslcertificates$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regionsslcertificates$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/sslCertificates/{sslCertificate}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['project', 'region', 'sslCertificate'], + pathParams: ['project', 'region', 'sslCertificate'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.regionSslCertificates.get + * @desc Returns the specified SslCertificate resource in the specified + * region. Get a list of available SSL certificates by making a list() + * request. + * @alias compute.regionSslCertificates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.sslCertificate Name of the SslCertificate resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Regionsslcertificates$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Regionsslcertificates$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Regionsslcertificates$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Regionsslcertificates$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Regionsslcertificates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/sslCertificates/{sslCertificate}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'region', 'sslCertificate'], + pathParams: ['project', 'region', 'sslCertificate'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.regionSslCertificates.insert + * @desc Creates a SslCertificate resource in the specified project and + * region using the data included in the request + * @alias compute.regionSslCertificates.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().SslCertificate} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Regionsslcertificates$Insert, + options?: MethodOptions): AxiosPromise; + insert( + params: Params$Resource$Regionsslcertificates$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Regionsslcertificates$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Regionsslcertificates$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regionsslcertificates$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/sslCertificates') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.regionSslCertificates.list + * @desc Retrieves the list of SslCertificate resources available to the + * specified project in the specified region. + * @alias compute.regionSslCertificates.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regionsslcertificates$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Regionsslcertificates$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Regionsslcertificates$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Regionsslcertificates$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regionsslcertificates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/sslCertificates') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.regionSslCertificates.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource and + * region. + * @alias compute.regionSslCertificates.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regionsslcertificates$Testiampermissions, + options?: MethodOptions): AxiosPromise; + testIamPermissions( + params: Params$Resource$Regionsslcertificates$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + testIamPermissions( + params: Params$Resource$Regionsslcertificates$Testiampermissions, + callback: BodyResponseCallback): void; + testIamPermissions( + callback: BodyResponseCallback): void; + testIamPermissions( + paramsOrCallback?: + Params$Resource$Regionsslcertificates$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regionsslcertificates$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsslcertificates$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionsslcertificates$Delete { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the SslCertificate resource to delete. + */ + sslCertificate?: string; + } + export interface Params$Resource$Regionsslcertificates$Get { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the SslCertificate resource to return. + */ + sslCertificate?: string; + } + export interface Params$Resource$Regionsslcertificates$Insert { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SslCertificate; + } + export interface Params$Resource$Regionsslcertificates$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionsslcertificates$Testiampermissions { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + + export class Resource$Regiontargethttpproxies { + root: Compute; + constructor(root: Compute) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * compute.regionTargetHttpProxies.delete + * @desc Deletes the specified TargetHttpProxy resource. + * @alias compute.regionTargetHttpProxies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetHttpProxy Name of the TargetHttpProxy resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regiontargethttpproxies$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Regiontargethttpproxies$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Regiontargethttpproxies$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Regiontargethttpproxies$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regiontargethttpproxies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['project', 'region', 'targetHttpProxy'], + pathParams: ['project', 'region', 'targetHttpProxy'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.regionTargetHttpProxies.get + * @desc Returns the specified TargetHttpProxy resource in the specified + * region. Gets a list of available target HTTP proxies by making a list() + * request. + * @alias compute.regionTargetHttpProxies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string} params.targetHttpProxy Name of the TargetHttpProxy resource to return. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Regiontargethttpproxies$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Regiontargethttpproxies$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Regiontargethttpproxies$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Regiontargethttpproxies$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regiontargethttpproxies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'region', 'targetHttpProxy'], + pathParams: ['project', 'region', 'targetHttpProxy'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.regionTargetHttpProxies.insert + * @desc Creates a TargetHttpProxy resource in the specified project and + * region using the data included in the request. + * @alias compute.regionTargetHttpProxies.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().TargetHttpProxy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Regiontargethttpproxies$Insert, + options?: MethodOptions): AxiosPromise; + insert( + params: Params$Resource$Regiontargethttpproxies$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Regiontargethttpproxies$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Regiontargethttpproxies$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regiontargethttpproxies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/targetHttpProxies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.regionTargetHttpProxies.list + * @desc Retrieves the list of TargetHttpProxy resources available to the + * specified project in the specified region. + * @alias compute.regionTargetHttpProxies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regiontargethttpproxies$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Regiontargethttpproxies$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Regiontargethttpproxies$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Regiontargethttpproxies$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regiontargethttpproxies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/targetHttpProxies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.regionTargetHttpProxies.setUrlMap + * @desc Changes the URL map for TargetHttpProxy. + * @alias compute.regionTargetHttpProxies.setUrlMap + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetHttpProxy Name of the TargetHttpProxy to set a URL map for. + * @param {().UrlMapReference} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setUrlMap( + params?: Params$Resource$Regiontargethttpproxies$Seturlmap, + options?: MethodOptions): AxiosPromise; + setUrlMap( + params: Params$Resource$Regiontargethttpproxies$Seturlmap, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setUrlMap( + params: Params$Resource$Regiontargethttpproxies$Seturlmap, + callback: BodyResponseCallback): void; + setUrlMap(callback: BodyResponseCallback): void; + setUrlMap( + paramsOrCallback?: Params$Resource$Regiontargethttpproxies$Seturlmap| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regiontargethttpproxies$Seturlmap; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiontargethttpproxies$Seturlmap; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region', 'targetHttpProxy'], + pathParams: ['project', 'region', 'targetHttpProxy'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.regionTargetHttpProxies.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.regionTargetHttpProxies.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Regiontargethttpproxies$Testiampermissions, + options?: MethodOptions): AxiosPromise; + testIamPermissions( + params: Params$Resource$Regiontargethttpproxies$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + testIamPermissions( + params: Params$Resource$Regiontargethttpproxies$Testiampermissions, + callback: BodyResponseCallback): void; + testIamPermissions( + callback: BodyResponseCallback): void; + testIamPermissions( + paramsOrCallback?: + Params$Resource$Regiontargethttpproxies$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regiontargethttpproxies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Regiontargethttpproxies$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/targetHttpProxies/{resource}/testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regiontargethttpproxies$Delete { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetHttpProxy resource to delete. + */ + targetHttpProxy?: string; + } + export interface Params$Resource$Regiontargethttpproxies$Get { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the TargetHttpProxy resource to return. + */ + targetHttpProxy?: string; + } + export interface Params$Resource$Regiontargethttpproxies$Insert { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetHttpProxy; + } + export interface Params$Resource$Regiontargethttpproxies$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regiontargethttpproxies$Seturlmap { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetHttpProxy to set a URL map for. + */ + targetHttpProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UrlMapReference; + } + export interface Params$Resource$Regiontargethttpproxies$Testiampermissions { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + + export class Resource$Regiontargethttpsproxies { root: Compute; constructor(root: Compute) { this.root = root; @@ -52472,45 +55017,45 @@ export namespace compute_alpha { /** - * compute.regionTargetHttpProxies.delete - * @desc Deletes the specified TargetHttpProxy resource. - * @alias compute.regionTargetHttpProxies.delete + * compute.regionTargetHttpsProxies.delete + * @desc Deletes the specified TargetHttpsProxy resource. + * @alias compute.regionTargetHttpsProxies.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {string} params.targetHttpProxy Name of the TargetHttpProxy resource to delete. + * @param {string} params.targetHttpsProxy Name of the TargetHttpsProxy resource to delete. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete( - params?: Params$Resource$Regiontargethttpproxies$Delete, + params?: Params$Resource$Regiontargethttpsproxies$Delete, options?: MethodOptions): AxiosPromise; delete( - params: Params$Resource$Regiontargethttpproxies$Delete, + params: Params$Resource$Regiontargethttpsproxies$Delete, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; delete( - params: Params$Resource$Regiontargethttpproxies$Delete, + params: Params$Resource$Regiontargethttpsproxies$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; delete( - paramsOrCallback?: Params$Resource$Regiontargethttpproxies$Delete| + paramsOrCallback?: Params$Resource$Regiontargethttpsproxies$Delete| BodyResponseCallback, optionsOrCallback?: MethodOptions| BodyResponseCallback, callback?: BodyResponseCallback): void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Regiontargethttpproxies$Delete; + Params$Resource$Regiontargethttpsproxies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiontargethttpproxies$Delete; + params = {} as Params$Resource$Regiontargethttpsproxies$Delete; options = {}; } @@ -52525,14 +55070,14 @@ export namespace compute_alpha { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}') + '/compute/alpha/projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}') .replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE' }, options), params, - requiredParams: ['project', 'region', 'targetHttpProxy'], - pathParams: ['project', 'region', 'targetHttpProxy'], + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], context: this.getRoot() }; if (callback) { @@ -52544,42 +55089,42 @@ export namespace compute_alpha { /** - * compute.regionTargetHttpProxies.get - * @desc Returns the specified TargetHttpProxy resource in the specified + * compute.regionTargetHttpsProxies.get + * @desc Returns the specified TargetHttpsProxy resource in the specified * region. Gets a list of available target HTTP proxies by making a list() * request. - * @alias compute.regionTargetHttpProxies.get + * @alias compute.regionTargetHttpsProxies.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. - * @param {string} params.targetHttpProxy Name of the TargetHttpProxy resource to return. + * @param {string} params.targetHttpsProxy Name of the TargetHttpsProxy resource to return. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - get(params?: Params$Resource$Regiontargethttpproxies$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Regiontargethttpproxies$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Regiontargethttpproxies$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Regiontargethttpproxies$Get| - BodyResponseCallback, + get(params?: Params$Resource$Regiontargethttpsproxies$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Regiontargethttpsproxies$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Regiontargethttpsproxies$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Regiontargethttpsproxies$Get| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Regiontargethttpproxies$Get; + Params$Resource$Regiontargethttpsproxies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiontargethttpproxies$Get; + params = {} as Params$Resource$Regiontargethttpsproxies$Get; options = {}; } @@ -52594,65 +55139,65 @@ export namespace compute_alpha { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}') + '/compute/alpha/projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}') .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params, - requiredParams: ['project', 'region', 'targetHttpProxy'], - pathParams: ['project', 'region', 'targetHttpProxy'], + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.regionTargetHttpProxies.insert - * @desc Creates a TargetHttpProxy resource in the specified project and + * compute.regionTargetHttpsProxies.insert + * @desc Creates a TargetHttpsProxy resource in the specified project and * region using the data included in the request. - * @alias compute.regionTargetHttpProxies.insert + * @alias compute.regionTargetHttpsProxies.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {().TargetHttpProxy} params.resource Request body data + * @param {().TargetHttpsProxy} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert( - params?: Params$Resource$Regiontargethttpproxies$Insert, + params?: Params$Resource$Regiontargethttpsproxies$Insert, options?: MethodOptions): AxiosPromise; insert( - params: Params$Resource$Regiontargethttpproxies$Insert, + params: Params$Resource$Regiontargethttpsproxies$Insert, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; insert( - params: Params$Resource$Regiontargethttpproxies$Insert, + params: Params$Resource$Regiontargethttpsproxies$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; insert( - paramsOrCallback?: Params$Resource$Regiontargethttpproxies$Insert| + paramsOrCallback?: Params$Resource$Regiontargethttpsproxies$Insert| BodyResponseCallback, optionsOrCallback?: MethodOptions| BodyResponseCallback, callback?: BodyResponseCallback): void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Regiontargethttpproxies$Insert; + Params$Resource$Regiontargethttpsproxies$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiontargethttpproxies$Insert; + params = {} as Params$Resource$Regiontargethttpsproxies$Insert; options = {}; } @@ -52667,7 +55212,7 @@ export namespace compute_alpha { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/targetHttpProxies') + '/compute/alpha/projects/{project}/regions/{region}/targetHttpsProxies') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, @@ -52686,10 +55231,10 @@ export namespace compute_alpha { /** - * compute.regionTargetHttpProxies.list - * @desc Retrieves the list of TargetHttpProxy resources available to the + * compute.regionTargetHttpsProxies.list + * @desc Retrieves the list of TargetHttpsProxy resources available to the * specified project in the specified region. - * @alias compute.regionTargetHttpProxies.list + * @alias compute.regionTargetHttpsProxies.list * @memberOf! () * * @param {object} params Parameters for request @@ -52704,30 +55249,31 @@ export namespace compute_alpha { * @return {object} Request object */ list( - params?: Params$Resource$Regiontargethttpproxies$List, - options?: MethodOptions): AxiosPromise; + params?: Params$Resource$Regiontargethttpsproxies$List, + options?: MethodOptions): AxiosPromise; list( - params: Params$Resource$Regiontargethttpproxies$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; + params: Params$Resource$Regiontargethttpsproxies$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; list( - params: Params$Resource$Regiontargethttpproxies$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; + params: Params$Resource$Regiontargethttpsproxies$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( - paramsOrCallback?: Params$Resource$Regiontargethttpproxies$List| - BodyResponseCallback, + paramsOrCallback?: Params$Resource$Regiontargethttpsproxies$List| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Regiontargethttpproxies$List; + Params$Resource$Regiontargethttpsproxies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiontargethttpproxies$List; + params = {} as Params$Resource$Regiontargethttpsproxies$List; options = {}; } @@ -52742,7 +55288,7 @@ export namespace compute_alpha { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/targetHttpProxies') + '/compute/alpha/projects/{project}/regions/{region}/targetHttpsProxies') .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, @@ -52753,54 +55299,129 @@ export namespace compute_alpha { context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * compute.regionTargetHttpProxies.setUrlMap - * @desc Changes the URL map for TargetHttpProxy. - * @alias compute.regionTargetHttpProxies.setUrlMap + * compute.regionTargetHttpsProxies.setSslCertificates + * @desc Replaces SslCertificates for TargetHttpsProxy. + * @alias compute.regionTargetHttpsProxies.setSslCertificates * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {string} params.targetHttpProxy Name of the TargetHttpProxy to set a URL map for. + * @param {string} params.targetHttpsProxy Name of the TargetHttpsProxy resource to set an SslCertificates resource for. + * @param {().RegionTargetHttpsProxiesSetSslCertificatesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setSslCertificates( + params?: Params$Resource$Regiontargethttpsproxies$Setsslcertificates, + options?: MethodOptions): AxiosPromise; + setSslCertificates( + params: Params$Resource$Regiontargethttpsproxies$Setsslcertificates, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setSslCertificates( + params: Params$Resource$Regiontargethttpsproxies$Setsslcertificates, + callback: BodyResponseCallback): void; + setSslCertificates(callback: BodyResponseCallback): void; + setSslCertificates( + paramsOrCallback?: + Params$Resource$Regiontargethttpsproxies$Setsslcertificates| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regiontargethttpsproxies$Setsslcertificates; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Regiontargethttpsproxies$Setsslcertificates; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.regionTargetHttpsProxies.setUrlMap + * @desc Changes the URL map for TargetHttpsProxy. + * @alias compute.regionTargetHttpsProxies.setUrlMap + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.targetHttpsProxy Name of the TargetHttpsProxy to set a URL map for. * @param {().UrlMapReference} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ setUrlMap( - params?: Params$Resource$Regiontargethttpproxies$Seturlmap, + params?: Params$Resource$Regiontargethttpsproxies$Seturlmap, options?: MethodOptions): AxiosPromise; setUrlMap( - params: Params$Resource$Regiontargethttpproxies$Seturlmap, + params: Params$Resource$Regiontargethttpsproxies$Seturlmap, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; setUrlMap( - params: Params$Resource$Regiontargethttpproxies$Seturlmap, + params: Params$Resource$Regiontargethttpsproxies$Seturlmap, callback: BodyResponseCallback): void; setUrlMap(callback: BodyResponseCallback): void; setUrlMap( - paramsOrCallback?: Params$Resource$Regiontargethttpproxies$Seturlmap| + paramsOrCallback?: Params$Resource$Regiontargethttpsproxies$Seturlmap| BodyResponseCallback, optionsOrCallback?: MethodOptions| BodyResponseCallback, callback?: BodyResponseCallback): void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Regiontargethttpproxies$Seturlmap; + Params$Resource$Regiontargethttpsproxies$Seturlmap; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regiontargethttpproxies$Seturlmap; + params = {} as Params$Resource$Regiontargethttpsproxies$Seturlmap; options = {}; } @@ -52815,14 +55436,14 @@ export namespace compute_alpha { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap') + '/compute/alpha/projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params, - requiredParams: ['project', 'region', 'targetHttpProxy'], - pathParams: ['project', 'region', 'targetHttpProxy'], + requiredParams: ['project', 'region', 'targetHttpsProxy'], + pathParams: ['project', 'region', 'targetHttpsProxy'], context: this.getRoot() }; if (callback) { @@ -52834,9 +55455,9 @@ export namespace compute_alpha { /** - * compute.regionTargetHttpProxies.testIamPermissions + * compute.regionTargetHttpsProxies.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. - * @alias compute.regionTargetHttpProxies.testIamPermissions + * @alias compute.regionTargetHttpsProxies.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request @@ -52849,34 +55470,34 @@ export namespace compute_alpha { * @return {object} Request object */ testIamPermissions( - params?: Params$Resource$Regiontargethttpproxies$Testiampermissions, + params?: Params$Resource$Regiontargethttpsproxies$Testiampermissions, options?: MethodOptions): AxiosPromise; testIamPermissions( - params: Params$Resource$Regiontargethttpproxies$Testiampermissions, + params: Params$Resource$Regiontargethttpsproxies$Testiampermissions, options: MethodOptions| BodyResponseCallback, callback: BodyResponseCallback): void; testIamPermissions( - params: Params$Resource$Regiontargethttpproxies$Testiampermissions, + params: Params$Resource$Regiontargethttpsproxies$Testiampermissions, callback: BodyResponseCallback): void; testIamPermissions( callback: BodyResponseCallback): void; testIamPermissions( paramsOrCallback?: - Params$Resource$Regiontargethttpproxies$Testiampermissions| + Params$Resource$Regiontargethttpsproxies$Testiampermissions| BodyResponseCallback, optionsOrCallback?: MethodOptions| BodyResponseCallback, callback?: BodyResponseCallback): void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Regiontargethttpproxies$Testiampermissions; + Params$Resource$Regiontargethttpsproxies$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = {} as - Params$Resource$Regiontargethttpproxies$Testiampermissions; + Params$Resource$Regiontargethttpsproxies$Testiampermissions; options = {}; } @@ -52891,7 +55512,7 @@ export namespace compute_alpha { { url: (rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/targetHttpProxies/{resource}/testIamPermissions') + '/compute/alpha/projects/{project}/regions/{region}/targetHttpsProxies/{resource}/testIamPermissions') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, @@ -52909,7 +55530,7 @@ export namespace compute_alpha { } } - export interface Params$Resource$Regiontargethttpproxies$Delete { + export interface Params$Resource$Regiontargethttpsproxies$Delete { /** * Auth client or API Key for the request */ @@ -52937,11 +55558,11 @@ export namespace compute_alpha { */ requestId?: string; /** - * Name of the TargetHttpProxy resource to delete. + * Name of the TargetHttpsProxy resource to delete. */ - targetHttpProxy?: string; + targetHttpsProxy?: string; } - export interface Params$Resource$Regiontargethttpproxies$Get { + export interface Params$Resource$Regiontargethttpsproxies$Get { /** * Auth client or API Key for the request */ @@ -52956,11 +55577,11 @@ export namespace compute_alpha { */ region?: string; /** - * Name of the TargetHttpProxy resource to return. + * Name of the TargetHttpsProxy resource to return. */ - targetHttpProxy?: string; + targetHttpsProxy?: string; } - export interface Params$Resource$Regiontargethttpproxies$Insert { + export interface Params$Resource$Regiontargethttpsproxies$Insert { /** * Auth client or API Key for the request */ @@ -52991,9 +55612,9 @@ export namespace compute_alpha { /** * Request body metadata */ - requestBody?: Schema$TargetHttpProxy; + requestBody?: Schema$TargetHttpsProxy; } - export interface Params$Resource$Regiontargethttpproxies$List { + export interface Params$Resource$Regiontargethttpsproxies$List { /** * Auth client or API Key for the request */ @@ -53051,7 +55672,7 @@ export namespace compute_alpha { */ region?: string; } - export interface Params$Resource$Regiontargethttpproxies$Seturlmap { + export interface Params$Resource$Regiontargethttpsproxies$Setsslcertificates { /** * Auth client or API Key for the request */ @@ -53079,16 +55700,54 @@ export namespace compute_alpha { */ requestId?: string; /** - * Name of the TargetHttpProxy to set a URL map for. + * Name of the TargetHttpsProxy resource to set an SslCertificates resource + * for. */ - targetHttpProxy?: string; + targetHttpsProxy?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionTargetHttpsProxiesSetSslCertificatesRequest; + } + export interface Params$Resource$Regiontargethttpsproxies$Seturlmap { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the TargetHttpsProxy to set a URL map for. + */ + targetHttpsProxy?: string; /** * Request body metadata */ requestBody?: Schema$UrlMapReference; } - export interface Params$Resource$Regiontargethttpproxies$Testiampermissions { + export interface Params$Resource$Regiontargethttpsproxies$Testiampermissions { /** * Auth client or API Key for the request */ @@ -53338,6 +55997,80 @@ export namespace compute_alpha { } + /** + * compute.regionUrlMaps.invalidateCache + * @desc Initiates a cache invalidation operation, invalidating the + * specified path, scoped to the specified UrlMap. + * @alias compute.regionUrlMaps.invalidateCache + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. + * @param {string} params.urlMap Name of the UrlMap scoping this request. + * @param {().CacheInvalidationRule} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + invalidateCache( + params?: Params$Resource$Regionurlmaps$Invalidatecache, + options?: MethodOptions): AxiosPromise; + invalidateCache( + params: Params$Resource$Regionurlmaps$Invalidatecache, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + invalidateCache( + params: Params$Resource$Regionurlmaps$Invalidatecache, + callback: BodyResponseCallback): void; + invalidateCache(callback: BodyResponseCallback): void; + invalidateCache( + paramsOrCallback?: Params$Resource$Regionurlmaps$Invalidatecache| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regionurlmaps$Invalidatecache; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionurlmaps$Invalidatecache; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/urlMaps/{urlMap}/invalidateCache') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region', 'urlMap'], + pathParams: ['project', 'region', 'urlMap'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.regionUrlMaps.list * @desc Retrieves the list of UrlMap resources available to the specified @@ -53779,6 +56512,35 @@ export namespace compute_alpha { */ requestBody?: Schema$UrlMap; } + export interface Params$Resource$Regionurlmaps$Invalidatecache { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * begin_interface: MixerMutationRequestBuilder Request ID to support + * idempotency. + */ + requestId?: string; + /** + * Name of the UrlMap scoping this request. + */ + urlMap?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CacheInvalidationRule; + } export interface Params$Resource$Regionurlmaps$List { /** * Auth client or API Key for the request @@ -55029,6 +57791,85 @@ export namespace compute_alpha { } + /** + * compute.routers.getNatMappingInfo + * @desc Retrieves runtime Nat mapping information of VM endpoints. + * @alias compute.routers.getNatMappingInfo + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string} params.router Name of the Router resource to query for Nat Mapping information of VM endpoints. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getNatMappingInfo( + params?: Params$Resource$Routers$Getnatmappinginfo, + options?: MethodOptions): + AxiosPromise; + getNatMappingInfo( + params: Params$Resource$Routers$Getnatmappinginfo, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + getNatMappingInfo( + params: Params$Resource$Routers$Getnatmappinginfo, + callback: BodyResponseCallback): void; + getNatMappingInfo( + callback: BodyResponseCallback): void; + getNatMappingInfo( + paramsOrCallback?: Params$Resource$Routers$Getnatmappinginfo| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Routers$Getnatmappinginfo; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Routers$Getnatmappinginfo; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'region', 'router'], + pathParams: ['project', 'region', 'router'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.routers.getRouterStatus * @desc Retrieves runtime information of the specified router. @@ -55643,6 +58484,69 @@ export namespace compute_alpha { */ router?: string; } + export interface Params$Resource$Routers$Getnatmappinginfo { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the Router resource to query for Nat Mapping information of VM + * endpoints. + */ + router?: string; + } export interface Params$Resource$Routers$Getrouterstatus { /** * Auth client or API Key for the request @@ -58316,6 +61220,88 @@ export namespace compute_alpha { } + /** + * compute.sslCertificates.aggregatedList + * @desc Retrieves the list of all SslCertificate resources, regional and + * global, available to the specified project. + * @alias compute.sslCertificates.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Name of the project scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Sslcertificates$Aggregatedlist, + options?: MethodOptions): + AxiosPromise; + aggregatedList( + params: Params$Resource$Sslcertificates$Aggregatedlist, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + aggregatedList( + params: Params$Resource$Sslcertificates$Aggregatedlist, + callback: BodyResponseCallback): + void; + aggregatedList( + callback: BodyResponseCallback): + void; + aggregatedList( + paramsOrCallback?: Params$Resource$Sslcertificates$Aggregatedlist| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Sslcertificates$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sslcertificates$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/aggregated/sslCertificates') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + /** * compute.sslCertificates.delete * @desc Deletes the specified SslCertificate resource. @@ -58671,6 +61657,60 @@ export namespace compute_alpha { } } + export interface Params$Resource$Sslcertificates$Aggregatedlist { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } export interface Params$Resource$Sslcertificates$Delete { /** * Auth client or API Key for the request @@ -60185,6 +63225,7 @@ export namespace compute_alpha { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.drainTimeoutSeconds The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped. * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). @@ -60783,6 +63824,17 @@ export namespace compute_alpha { */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * The drain timeout specifies the upper bound in seconds on the amount of + * time allowed to drain connections from the current ACTIVE subnetwork to + * the current BACKUP subnetwork. The drain timeout is only applicable when + * the following conditions are true: - the subnetwork being patched has + * purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has + * role = BACKUP - the patch request is setting the role to ACTIVE. Note + * that after this patch operation the roles of the ACTIVE and BACKUP + * subnetworks will be swapped. + */ + drainTimeoutSeconds?: number; /** * Project ID for this request. */ @@ -61671,6 +64723,88 @@ export namespace compute_alpha { } + /** + * compute.targetHttpsProxies.aggregatedList + * @desc Retrieves the list of all TargetHttpsProxy resources, regional and + * global, available to the specified project. + * @alias compute.targetHttpsProxies.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Name of the project scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Targethttpsproxies$Aggregatedlist, + options?: MethodOptions): + AxiosPromise; + aggregatedList( + params: Params$Resource$Targethttpsproxies$Aggregatedlist, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + aggregatedList( + params: Params$Resource$Targethttpsproxies$Aggregatedlist, + callback: BodyResponseCallback): + void; + aggregatedList( + callback: BodyResponseCallback): + void; + aggregatedList( + paramsOrCallback?: Params$Resource$Targethttpsproxies$Aggregatedlist| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Targethttpsproxies$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targethttpsproxies$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/alpha/projects/{project}/aggregated/targetHttpsProxies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + /** * compute.targetHttpsProxies.delete * @desc Deletes the specified TargetHttpsProxy resource. @@ -62322,6 +65456,60 @@ export namespace compute_alpha { } } + export interface Params$Resource$Targethttpsproxies$Aggregatedlist { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } export interface Params$Resource$Targethttpsproxies$Delete { /** * Auth client or API Key for the request @@ -67071,6 +70259,81 @@ export namespace compute_alpha { } + /** + * compute.urlMaps.aggregatedList + * @desc Retrieves the list of all UrlMap resources, regional and global, + * available to the specified project. + * @alias compute.urlMaps.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Name of the project scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Urlmaps$Aggregatedlist, + options?: MethodOptions): AxiosPromise; + aggregatedList( + params: Params$Resource$Urlmaps$Aggregatedlist, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + aggregatedList( + params: Params$Resource$Urlmaps$Aggregatedlist, + callback: BodyResponseCallback): void; + aggregatedList( + callback: BodyResponseCallback): void; + aggregatedList( + paramsOrCallback?: Params$Resource$Urlmaps$Aggregatedlist| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Urlmaps$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlmaps$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/compute/alpha/projects/{project}/aggregated/urlMaps') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.urlMaps.delete * @desc Deletes the specified UrlMap resource. @@ -67704,6 +70967,60 @@ export namespace compute_alpha { } } + export interface Params$Resource$Urlmaps$Aggregatedlist { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + } export interface Params$Resource$Urlmaps$Delete { /** * Auth client or API Key for the request diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 6513281f85d..34cbade30cc 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -91,6 +91,7 @@ export namespace compute_beta { regionInstanceGroups: Resource$Regioninstancegroups; regionOperations: Resource$Regionoperations; regions: Resource$Regions; + resourcePolicies: Resource$Resourcepolicies; routers: Resource$Routers; routes: Resource$Routes; securityPolicies: Resource$Securitypolicies; @@ -157,6 +158,7 @@ export namespace compute_beta { this.regionInstanceGroups = new Resource$Regioninstancegroups(this); this.regionOperations = new Resource$Regionoperations(this); this.regions = new Resource$Regions(this); + this.resourcePolicies = new Resource$Resourcepolicies(this); this.routers = new Resource$Routers(this); this.routes = new Resource$Routes(this); this.securityPolicies = new Resource$Securitypolicies(this); @@ -688,7 +690,8 @@ export namespace compute_beta { export interface Schema$AttachedDiskInitializeParams { /** * Specifies the disk name. If not specified, the default is to use the name - * of the instance. + * of the instance. If the disk with the instance name exists already in the + * given zone/region, a new name will be automatically generated. */ diskName?: string; /** @@ -1205,7 +1208,7 @@ export namespace compute_beta { */ bucketName?: string; /** - * Cloud CDN Coniguration for this BackendBucket. + * Cloud CDN configuration for this BackendBucket. */ cdnPolicy?: Schema$BackendBucketCdnPolicy; /** @@ -1249,18 +1252,17 @@ export namespace compute_beta { */ export interface Schema$BackendBucketCdnPolicy { /** - * Number of seconds up to which the response to a signed URL request will - * be cached in the CDN. After this time period, the Signed URL will be - * revalidated before being served. Defaults to 1hr (3600s). If this field - * is set, Cloud CDN will internally act as though all responses from this - * bucket had a ?Cache-Control: public, max-age=[TTL]? header, regardless of - * any existing Cache-Control header. The actual headers served in responses - * will not be altered. + * Maximum number of seconds the response to a signed URL request will be + * considered fresh. After this time period, the response will be + * revalidated before being served. Defaults to 1hr (3600s). When serving + * responses to signed URL requests, Cloud CDN will internally behave as + * though all responses from this backend had a ?Cache-Control: public, + * max-age=[TTL]? header, regardless of any existing Cache-Control header. + * The actual headers served in responses will not be altered. */ signedUrlCacheMaxAgeSec?: string; /** - * [Output Only] Names of the keys currently configured for Cloud CDN Signed - * URL on this backend bucket. + * [Output Only] Names of the keys for signing request URLs. */ signedUrlKeyNames?: string[]; } @@ -1342,7 +1344,8 @@ export namespace compute_beta { * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. This field will be * ignored when inserting a BackendService. An up-to-date fingerprint must - * be provided in order to update the BackendService. + * be provided in order to update the BackendService. To see the latest + * fingerprint, make a get() request to retrieve a BackendService. */ fingerprint?: string; /** @@ -1474,18 +1477,17 @@ export namespace compute_beta { */ cacheKeyPolicy?: Schema$CacheKeyPolicy; /** - * Number of seconds up to which the response to a signed URL request will - * be cached in the CDN. After this time period, the Signed URL will be - * revalidated before being served. Defaults to 1hr (3600s). If this field - * is set, Cloud CDN will internally act as though all responses from this - * backend had a ?Cache-Control: public, max-age=[TTL]? header, regardless - * of any existing Cache-Control header. The actual headers served in - * responses will not be altered. + * Maximum number of seconds the response to a signed URL request will be + * considered fresh. After this time period, the response will be + * revalidated before being served. Defaults to 1hr (3600s). When serving + * responses to signed URL requests, Cloud CDN will internally behave as + * though all responses from this backend had a ?Cache-Control: public, + * max-age=[TTL]? header, regardless of any existing Cache-Control header. + * The actual headers served in responses will not be altered. */ signedUrlCacheMaxAgeSec?: string; /** - * [Output Only] Names of the keys currently configured for Cloud CDN Signed - * URL on this backend service. + * [Output Only] Names of the keys for signing request URLs. */ signedUrlKeyNames?: string[]; } @@ -1562,10 +1564,10 @@ export namespace compute_beta { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: an unsatisfied - * condition will not allow user access via current binding. Different - * bindings, including their conditions, are examined independently. This - * field is only visible as GOOGLE_INTERNAL or CONDITION_TRUSTED_TESTER. + * Unimplemented. The condition that is associated with this binding. NOTE: + * an unsatisfied condition will not allow user access via current binding. + * Different bindings, including their conditions, are examined + * independently. */ condition?: Schema$Expr; /** @@ -2005,6 +2007,10 @@ export namespace compute_beta { * for regional resources. */ replicaZones?: string[]; + /** + * Resource policies applied to this disk for automatic snapshot creations. + */ + resourcePolicies?: string[]; /** * [Output Only] Server-defined fully-qualified URL for this resource. */ @@ -2210,6 +2216,18 @@ export namespace compute_beta { */ targetDisk?: string; } + export interface Schema$DisksAddResourcePoliciesRequest { + /** + * Resource policies to be added to this disk. + */ + resourcePolicies?: string[]; + } + export interface Schema$DisksRemoveResourcePoliciesRequest { + /** + * Resource policies to be removed from this disk. + */ + resourcePolicies?: string[]; + } export interface Schema$DisksResizeRequest { /** * The new size of the persistent disk, which is specified in GB. @@ -2360,12 +2378,15 @@ export namespace compute_beta { warning?: any; } export interface Schema$DistributionPolicy { + /** + * Zones where the regional managed instance group will create and manage + * instances. + */ zones?: Schema$DistributionPolicyZoneConfiguration[]; } export interface Schema$DistributionPolicyZoneConfiguration { /** - * URL of the zone where managed instance group is spawning instances (for - * regional resources). Zone has to belong to the region where managed + * The URL of the zone. The zone must exist in the region where the managed * instance group is located. */ zone?: string; @@ -2618,7 +2639,7 @@ export namespace compute_beta { */ export interface Schema$ForwardingRule { /** - * This field is not used for external load balancing. For internal load + * This field is only used for INTERNAL load balancing. For internal load * balancing, this field identifies the BackendService resource to receive * the matched traffic. */ @@ -2647,12 +2668,14 @@ export namespace compute_beta { * field is empty, an ephemeral IPv4 address from the same scope (global or * regional) will be assigned. A regional forwarding rule supports IPv4 * only. A global forwarding rule supports either IPv4 or IPv6. When the - * load balancing scheme is INTERNAL, this can only be an RFC 1918 IP - * address belonging to the network/subnet configured for the forwarding - * rule. By default, if this field is empty, an ephemeral internal IP - * address will be automatically allocated from the IP range of the subnet - * or network configured for this forwarding rule. An address can be - * specified either by a literal IP address or a URL reference to an + * load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL + * reference to an existing Address resource ( internal regional static IP + * address). When the load balancing scheme is INTERNAL, this can only be + * an RFC 1918 IP address belonging to the network/subnet configured for the + * forwarding rule. By default, if this field is empty, an ephemeral + * internal IP address will be automatically allocated from the IP range of + * the subnet or network configured for this forwarding rule. An address + * can be specified either by a literal IP address or a URL reference to an * existing Address resource. The following examples are all valid: - * 100.1.2.3 - * https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address @@ -2663,13 +2686,14 @@ export namespace compute_beta { /** * The IP protocol to which this rule applies. Valid options are TCP, UDP, * ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only - * TCP and UDP are valid. + * TCP and UDP are valid. When the load balancing scheme is + * INTERNAL_SELF_MANAGED, only TCPis valid. */ IPProtocol?: string; /** * The IP Version that will be used by this forwarding rule. Valid options - * are IPV4 or IPV6. This can only be specified for a global forwarding - * rule. + * are IPV4 or IPV6. This can only be specified for an external global + * forwarding rule. */ ipVersion?: string; /** @@ -2695,10 +2719,12 @@ export namespace compute_beta { labels?: any; /** * This signifies what the ForwardingRule will be used for and can only take - * the following values: INTERNAL, EXTERNAL The value of INTERNAL means that - * this will be used for Internal Network Load Balancing (TCP, UDP). The - * value of EXTERNAL means that this will be used for External Load - * Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) + * the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The + * value of INTERNAL means that this will be used for Internal Network Load + * Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this + * will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means + * that this will be used for External Load Balancing (HTTP(S) LB, External + * TCP/UDP LB, SSL Proxy) */ loadBalancingScheme?: string; /** @@ -2712,10 +2738,10 @@ export namespace compute_beta { */ name?: string; /** - * This field is not used for external load balancing. For internal load - * balancing, this field identifies the network that the load balanced IP - * should belong to for this Forwarding Rule. If this field is not - * specified, the default network will be used. + * This field is not used for external load balancing. For INTERNAL and + * INTERNAL_SELF_MANAGED load balancing, this field identifies the network + * that the load balanced IP should belong to for this Forwarding Rule. If + * this field is not specified, the default network will be used. */ network?: string; /** @@ -2777,7 +2803,7 @@ export namespace compute_beta { */ serviceName?: string; /** - * This field is not used for external load balancing. For internal load + * This field is only used for INTERNAL load balancing. For internal load * balancing, this field identifies the subnetwork that the load balanced IP * should belong to for this Forwarding Rule. If the network specified is * in auto subnet mode, this field is optional. However, if the network is @@ -2789,7 +2815,8 @@ export namespace compute_beta { * regional forwarding rules, this target must live in the same region as * the forwarding rule. For global forwarding rules, this target must be a * global load balancing resource. The forwarded traffic must be of a type - * appropriate to the target object. + * appropriate to the target object. For INTERNAL_SELF_MANAGED" load + * balancing, only HTTP and HTTPS targets are valid. */ target?: string; } @@ -2893,6 +2920,25 @@ export namespace compute_beta { */ labels?: any; } + export interface Schema$GlobalSetPolicyRequest { + /** + * Flatten Policy to create a backwacd compatible wire-format. Deprecated. + * Use 'policy' to specify bindings. + */ + bindings?: Schema$Binding[]; + /** + * Flatten Policy to create a backward compatible wire-format. Deprecated. + * Use 'policy' to specify the etag. + */ + etag?: string; + /** + * REQUIRED: The complete policy to be applied to the 'resource'. + * The size of the policy is limited to a few 10s of KB. An empty policy is + * in general a valid policy but certain services (like Projects) might + * reject them. + */ + policy?: Schema$Policy; + } /** * Guest OS features. */ @@ -3279,51 +3325,6 @@ export namespace compute_beta { */ warning?: any; } - export interface Schema$HTTPSHealthCheck { - /** - * The value of the host header in the HTTPS health check request. If left - * empty (default value), the IP on behalf of which this health check is - * performed will be used. - */ - host?: string; - /** - * The TCP port number for the health check request. The default value is - * 443. Valid values are 1 through 65535. - */ - port?: number; - /** - * Port name as defined in InstanceGroup#NamedPort#name. If both port and - * port_name are defined, port takes precedence. - */ - portName?: string; - /** - * Specifies how port is selected for health checking, can be one of - * following values: USE_FIXED_PORT: The port number in port is used for - * health checking. USE_NAMED_PORT: The portName is used for health - * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified - * for each network endpoint is used for health checking. For other - * backends, the port or named port specified in the Backend Service is used - * for health checking. If not specified, HTTPS health check follows - * behavior specified in port and portName fields. - */ - portSpecification?: string; - /** - * Specifies the type of proxy header to append before sending data to the - * backend, either NONE or PROXY_V1. The default is NONE. - */ - proxyHeader?: string; - /** - * The request path of the HTTPS health check request. The default value is - * /. - */ - requestPath?: string; - /** - * The string to match anywhere in the first 1024 bytes of the response - * body. If left empty (the default value), the status code determines - * health. The response data can only be ASCII. - */ - response?: string; - } /** * An HttpsHealthCheck resource. This resource defines a template for how * individual instances should be checked for health, via HTTPS. @@ -3399,6 +3400,51 @@ export namespace compute_beta { */ unhealthyThreshold?: number; } + export interface Schema$HTTPSHealthCheck { + /** + * The value of the host header in the HTTPS health check request. If left + * empty (default value), the IP on behalf of which this health check is + * performed will be used. + */ + host?: string; + /** + * The TCP port number for the health check request. The default value is + * 443. Valid values are 1 through 65535. + */ + port?: number; + /** + * Port name as defined in InstanceGroup#NamedPort#name. If both port and + * port_name are defined, port takes precedence. + */ + portName?: string; + /** + * Specifies how port is selected for health checking, can be one of + * following values: USE_FIXED_PORT: The port number in port is used for + * health checking. USE_NAMED_PORT: The portName is used for health + * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified + * for each network endpoint is used for health checking. For other + * backends, the port or named port specified in the Backend Service is used + * for health checking. If not specified, HTTPS health check follows + * behavior specified in port and portName fields. + */ + portSpecification?: string; + /** + * Specifies the type of proxy header to append before sending data to the + * backend, either NONE or PROXY_V1. The default is NONE. + */ + proxyHeader?: string; + /** + * The request path of the HTTPS health check request. The default value is + * /. + */ + requestPath?: string; + /** + * The string to match anywhere in the first 1024 bytes of the response + * body. If left empty (the default value), the status code determines + * health. The response data can only be ASCII. + */ + response?: string; + } /** * Contains a list of HttpsHealthCheck resources. */ @@ -3547,9 +3593,9 @@ export namespace compute_beta { */ sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * The ID value of the disk used to create this image. This value may be - * used to determine whether the image was taken from the current or a - * previous instance of a given disk name. + * [Output Only] The ID value of the disk used to create this image. This + * value may be used to determine whether the image was taken from the + * current or a previous instance of a given disk name. */ sourceDiskId?: string; /** @@ -3995,7 +4041,8 @@ export namespace compute_beta { */ description?: string; /** - * Policy valid only for regional managed instance groups. + * Policy specifying intended distribution of instances in regional managed + * instance group. */ distributionPolicy?: Schema$DistributionPolicy; /** @@ -4007,7 +4054,8 @@ export namespace compute_beta { * Fingerprint of this resource. This field may be used in optimistic * locking. It will be ignored when inserting an InstanceGroupManager. An * up-to-date fingerprint must be provided in order to update the - * InstanceGroupManager. + * InstanceGroupManager. To see the latest fingerprint, make a get() + * request to retrieve an InstanceGroupManager. */ fingerprint?: string; /** @@ -5904,7 +5952,9 @@ export namespace compute_beta { * the metadata's contents and used for optimistic locking. The * fingerprint is initially generated by Compute Engine and changes after * every request to modify or update metadata. You must always provide an - * up-to-date fingerprint hash in order to update or change metadata. + * up-to-date fingerprint hash in order to update or change metadata. To + * see the latest fingerprint, make a get() request to retrieve the + * resource. */ fingerprint?: string; /** @@ -6011,9 +6061,9 @@ export namespace compute_beta { export interface Schema$NetworkEndpoint { /** * The name for a specific VM instance that the IP address belongs to. This - * is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. - * The instance must be in the same zone of network endpoint group. The - * name must be 1-63 characters long, and comply with RFC1035. + * is required for network endpoints of type GCE_VM_IP_PORT. The instance + * must be in the same zone of network endpoint group. The name must be + * 1-63 characters long, and comply with RFC1035. */ instance?: string; /** @@ -6055,8 +6105,8 @@ export namespace compute_beta { */ kind?: string; /** - * This field is only valid when the network endpoint group type is - * LOAD_BALANCING. + * This field is only valid when the network endpoint group is used for load + * balancing. */ loadBalancer?: Schema$NetworkEndpointGroupLbNetworkEndpointGroup; /** @@ -6070,8 +6120,8 @@ export namespace compute_beta { */ name?: string; /** - * Type of network endpoints in this network endpoint group. Only supported - * values for LOAD_BALANCING are GCE_VM_IP or GCE_VM_IP_PORT. + * Type of network endpoints in this network endpoint group. Currently the + * only supported value is GCE_VM_IP_PORT. */ networkEndpointType?: string; /** @@ -6082,11 +6132,6 @@ export namespace compute_beta { * [Output only] Number of network endpoints in the network endpoint group. */ size?: number; - /** - * Specify the type of this network endpoint group. Only LOAD_BALANCING is - * valid for now. - */ - type?: string; } export interface Schema$NetworkEndpointGroupAggregatedList { /** @@ -6121,14 +6166,12 @@ export namespace compute_beta { warning?: any; } /** - * Load balancing specific fields for network endpoint group of type - * LOAD_BALANCING. + * Load balancing specific fields for network endpoint group. */ export interface Schema$NetworkEndpointGroupLbNetworkEndpointGroup { /** * The default port used if the port number is not specified in the network - * endpoint. If the network endpoint type is GCE_VM_IP, this field must not - * be specified. + * endpoint. */ defaultPort?: number; /** @@ -6456,7 +6499,8 @@ export namespace compute_beta { */ name?: string; /** - * [Output Only] A list of nodes in this node group. + * [Deprecated] Use nodeGroups.listNodes instead. [Output Only] A list of + * nodes in this node group. */ nodes?: Schema$NodeGroupNode[]; /** @@ -6467,6 +6511,10 @@ export namespace compute_beta { * [Output Only] Server-defined URL for the resource. */ selfLink?: string; + /** + * [Output Only] The total number of nodes in the node group. + */ + size?: number; status?: string; /** * [Output Only] The name of the zone where the node group resides, such as @@ -6552,6 +6600,7 @@ export namespace compute_beta { * The type of this node. */ nodeType?: string; + status?: string; } export interface Schema$NodeGroupsAddNodesRequest { /** @@ -6562,6 +6611,38 @@ export namespace compute_beta { export interface Schema$NodeGroupsDeleteNodesRequest { nodes?: string[]; } + export interface Schema$NodeGroupsListNodes { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of Node resources. + */ + items?: Schema$NodeGroupNode[]; + /** + * [Output Only] The resource type, which is always + * compute.nodeGroupsListNodes for the list of nodes in the specified node + * group. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } export interface Schema$NodeGroupsScopedList { /** * [Output Only] A list of node groups contained in this scope. @@ -7416,6 +7497,18 @@ export namespace compute_beta { */ warning?: any; } + export interface Schema$RegionDisksAddResourcePoliciesRequest { + /** + * Resource policies to be added to this disk. + */ + resourcePolicies?: string[]; + } + export interface Schema$RegionDisksRemoveResourcePoliciesRequest { + /** + * Resource policies to be removed from this disk. + */ + resourcePolicies?: string[]; + } export interface Schema$RegionDisksResizeRequest { /** * The new size of the regional persistent disk, which is specified in GB. @@ -7731,125 +7824,362 @@ export namespace compute_beta { */ group?: string; } - /** - * Represents a Route resource. A route specifies how certain packets should - * be handled by the network. Routes are associated with instances by tags and - * the set of routes for a particular instance is called its routing table. - * For each packet leaving an instance, the system searches that - * instance's routing table for a single best matching route. Routes match - * packets by destination IP address, preferring smaller or more specific - * ranges over larger ones. If there is a tie, the system selects the route - * with the smallest priority value. If there is still a tie, it uses the - * layer three and four packet headers to select just one of the remaining - * matching routes. The packet is then forwarded as specified by the nextHop - * field of the winning route - either to another instance destination, an - * instance gateway, or a Google Compute Engine-operated gateway. Packets - * that do not match any route in the sending instance's routing table are - * dropped. (== resource_for beta.routes ==) (== resource_for v1.routes ==) - */ - export interface Schema$Route { - /** - * [Output Only] Creation timestamp in RFC3339 text format. - */ - creationTimestamp?: string; - /** - * An optional description of this resource. Provide this property when you - * create the resource. - */ - description?: string; - /** - * The destination range of outgoing packets that this route applies to. - * Only IPv4 is supported. - */ - destRange?: string; + export interface Schema$ResourcePoliciesList { + etag?: string; /** * [Output Only] The unique identifier for the resource. This identifier is * defined by the server. */ id?: string; /** - * [Output Only] Type of this resource. Always compute#routes for Route - * resources. + * [Output Only] A list of ResourcePolicy resources. */ - kind?: string; + items?: Schema$ResourcePolicy[]; /** - * Name of the resource. Provided by the client when the resource is - * created. The name must be 1-63 characters long, and comply with RFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character - * must be a lowercase letter, and all following characters must be a dash, - * lowercase letter, or digit, except the last character, which cannot be a - * dash. + * [Output Only] Type of resource.Always compute#resourcePoliciesList for + * listsof resourcePolicies */ - name?: string; + kind?: string; /** - * Fully-qualified URL of the network that this route applies to. + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. */ - network?: string; + nextPageToken?: string; /** - * The URL to a gateway that should handle matching packets. You can only - * specify the internet gateway using a full or partial valid URL: - * projects/<project-id>/global/gateways/default-internet-gateway + * [Output Only] Server-defined URL for this resource. */ - nextHopGateway?: string; + selfLink?: string; /** - * The URL to an instance that should handle matching packets. You can - * specify this as a full or partial URL. For example: - * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ + * [Output Only] Informational warning message. */ - nextHopInstance?: string; + warning?: any; + } + export interface Schema$ResourcePoliciesScopedList { /** - * The network IP address of an instance that should handle matching - * packets. Only IPv4 is supported. + * A list of resourcePolicies contained in this scope. */ - nextHopIp?: string; + resourcePolicies?: Schema$ResourcePolicy[]; /** - * The URL of the local network if it should handle matching packets. + * Informational warning which replaces the list of resourcePolicies when + * the list is empty. */ - nextHopNetwork?: string; + warning?: any; + } + export interface Schema$ResourcePolicy { /** - * [Output Only] The network peering name that should handle matching - * packets, which should conform to RFC1035. + * Resource policy for persistent disks for creating snapshots. */ - nextHopPeering?: string; + backupSchedulePolicy?: Schema$ResourcePolicyBackupSchedulePolicy; /** - * The URL to a VpnTunnel that should handle matching packets. + * [Output Only] Creation timestamp in RFC3339 text format. */ - nextHopVpnTunnel?: string; + creationTimestamp?: string; + description?: string; /** - * The priority of this route. Priority is used to break ties in cases where - * there is more than one matching route of equal prefix length. In the case - * of two routes with equal prefix length, the one with the lowest-numbered - * priority value wins. Default value is 1000. Valid range is 0 through - * 65535. + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. */ - priority?: number; + id?: string; /** - * [Output Only] Server-defined fully-qualified URL for this resource. + * [Output Only] Type of the resource. Always compute#resource_policies for + * resource policies. */ - selfLink?: string; + kind?: string; /** - * A list of instance tags to which this route applies. + * The name of the resource, provided by the client when initially creating + * the resource. The resource name must be 1-63 characters long, and comply + * with RFC1035. Specifically, the name must be 1-63 characters long and + * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the + * first character must be a lowercase letter, and all following characters + * must be a dash, lowercase letter, or digit, except the last character, + * which cannot be a dash. */ - tags?: string[]; + name?: string; + region?: string; /** - * [Output Only] If potential misconfigurations are detected for this route, - * this field will be populated with warning messages. + * [Output Only] Server-defined fully-qualified URL for this resource. */ - warnings?: any[]; + selfLink?: string; } /** - * Contains a list of Route resources. + * Contains a list of resourcePolicies. */ - export interface Schema$RouteList { + export interface Schema$ResourcePolicyAggregatedList { + etag?: string; /** * [Output Only] Unique identifier for the resource; defined by the server. */ id?: string; /** - * A list of Route resources. + * A list of ResourcePolicy resources. */ - items?: Schema$Route[]; + items?: any; + /** + * Type of resource. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } + /** + * A backup schedule policy specifies when and how frequently snapshots are to + * be created for the target disk. Also specifies how many and how long these + * automatically created snapshot should be retained. + */ + export interface Schema$ResourcePolicyBackupSchedulePolicy { + /** + * Retention policy applied to snapshots created by this resource policy. + */ + retentionPolicy?: Schema$ResourcePolicyBackupSchedulePolicyRetentionPolicy; + /** + * A Vm Maintenance Policy specifies what kind of infrastructure maintenance + * we are allowed to perform on this VM and when. Schedule that is applied + * to disks covered by this policy. + */ + schedule?: Schema$ResourcePolicyBackupSchedulePolicySchedule; + /** + * Properties with which snapshots are created such as lables, encryption + * keys. + */ + snapshotProperties?: + Schema$ResourcePolicyBackupSchedulePolicySnapshotProperties; + } + /** + * Policy for retention of automatically created snapshots. + */ + export interface Schema$ResourcePolicyBackupSchedulePolicyRetentionPolicy { + /** + * Maximum age of the snapshot that is allowed to be kept. + */ + maxRetentionDays?: number; + } + /** + * A schedule for disks where the schedueled operations are performed. + */ + export interface Schema$ResourcePolicyBackupSchedulePolicySchedule { + dailySchedule?: Schema$ResourcePolicyDailyCycle; + hourlySchedule?: Schema$ResourcePolicyHourlyCycle; + weeklySchedule?: Schema$ResourcePolicyWeeklyCycle; + } + /** + * Specified snapshot properties for automatic snapshots created by this + * policy. + */ + export interface Schema$ResourcePolicyBackupSchedulePolicySnapshotProperties { + /** + * Indication to perform a ?guest aware? snapshot. + */ + guestFlush?: boolean; + /** + * Labels to apply to automatic snapshots. These can be later modified by + * the setLabels method. Label values may be empty. + */ + labels?: any; + /** + * GCS bucket storage location of the auto snapshot (regional or + * multi-regional). + */ + storageLocations?: string[]; + } + /** + * Time window specified for daily operations. + */ + export interface Schema$ResourcePolicyDailyCycle { + /** + * Allows to define schedule that runs every nth day of the month. + */ + daysInCycle?: number; + /** + * [Output only] Duration of the time window, automatically chosen to be + * smallest possible in the given scenario. + */ + duration?: string; + /** + * Time within the window to start the operations. It must be in format + * "HH:MM?, where HH : [00-23] and MM : [00-59] GMT. + */ + startTime?: string; + } + /** + * Time window specified for hourly operations. + */ + export interface Schema$ResourcePolicyHourlyCycle { + /** + * [Output only] Duration of the time window, automatically chosen to be + * smallest possible in the given scenario. + */ + duration?: string; + /** + * Allows to define schedule that runs every nth hour. + */ + hoursInCycle?: number; + /** + * Time within the window to start the operations. It must be in format + * "HH:MM?, where HH : [00-23] and MM : [00-59] GMT. + */ + startTime?: string; + } + /** + * Time window specified for weekly operations. + */ + export interface Schema$ResourcePolicyWeeklyCycle { + /** + * Up to 7 intervals/windows, one for each day of the week. + */ + dayOfWeeks?: Schema$ResourcePolicyWeeklyCycleDayOfWeek[]; + } + export interface Schema$ResourcePolicyWeeklyCycleDayOfWeek { + /** + * Allows to define schedule that runs specified day of the week. + */ + day?: string; + /** + * [Output only] Duration of the time window, automatically chosen to be + * smallest possible in the given scenario. + */ + duration?: string; + /** + * Time within the window to start the operations. It must be in format + * "HH:MM?, where HH : [00-23] and MM : [00-59] GMT. + */ + startTime?: string; + } + /** + * Represents a Route resource. A route specifies how certain packets should + * be handled by the network. Routes are associated with instances by tags and + * the set of routes for a particular instance is called its routing table. + * For each packet leaving an instance, the system searches that + * instance's routing table for a single best matching route. Routes match + * packets by destination IP address, preferring smaller or more specific + * ranges over larger ones. If there is a tie, the system selects the route + * with the smallest priority value. If there is still a tie, it uses the + * layer three and four packet headers to select just one of the remaining + * matching routes. The packet is then forwarded as specified by the nextHop + * field of the winning route - either to another instance destination, an + * instance gateway, or a Google Compute Engine-operated gateway. Packets + * that do not match any route in the sending instance's routing table are + * dropped. (== resource_for beta.routes ==) (== resource_for v1.routes ==) + */ + export interface Schema$Route { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string; + /** + * An optional description of this resource. Provide this property when you + * create the resource. + */ + description?: string; + /** + * The destination range of outgoing packets that this route applies to. + * Only IPv4 is supported. + */ + destRange?: string; + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id?: string; + /** + * [Output Only] Type of this resource. Always compute#routes for Route + * resources. + */ + kind?: string; + /** + * Name of the resource. Provided by the client when the resource is + * created. The name must be 1-63 characters long, and comply with RFC1035. + * Specifically, the name must be 1-63 characters long and match the regular + * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character + * must be a lowercase letter, and all following characters must be a dash, + * lowercase letter, or digit, except the last character, which cannot be a + * dash. + */ + name?: string; + /** + * Fully-qualified URL of the network that this route applies to. + */ + network?: string; + /** + * The URL to a gateway that should handle matching packets. You can only + * specify the internet gateway using a full or partial valid URL: + * projects/<project-id>/global/gateways/default-internet-gateway + */ + nextHopGateway?: string; + /** + * The URL to an instance that should handle matching packets. You can + * specify this as a full or partial URL. For example: + * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ + */ + nextHopInstance?: string; + /** + * The network IP address of an instance that should handle matching + * packets. Only IPv4 is supported. + */ + nextHopIp?: string; + /** + * The URL of the local network if it should handle matching packets. + */ + nextHopNetwork?: string; + /** + * [Output Only] The network peering name that should handle matching + * packets, which should conform to RFC1035. + */ + nextHopPeering?: string; + /** + * The URL to a VpnTunnel that should handle matching packets. + */ + nextHopVpnTunnel?: string; + /** + * The priority of this route. Priority is used to break ties in cases where + * there is more than one matching route of equal prefix length. In the case + * of two routes with equal prefix length, the one with the lowest-numbered + * priority value wins. Default value is 1000. Valid range is 0 through + * 65535. + */ + priority?: number; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string; + /** + * A list of instance tags to which this route applies. + */ + tags?: string[]; + /** + * [Output Only] If potential misconfigurations are detected for this route, + * this field will be populated with warning messages. + */ + warnings?: any[]; + } + /** + * Contains a list of Route resources. + */ + export interface Schema$RouteList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of Route resources. + */ + items?: Schema$Route[]; /** * Type of resource. */ @@ -8316,7 +8646,8 @@ export namespace compute_beta { } /** * A security policy is comprised of one or more rules. It can also be - * associated with one or more 'targets'. Next available tag: 11 + * associated with one or more 'targets'. Next available tag: 11 (== + * resource_for beta.securityPolicies ==) */ export interface Schema$SecurityPolicy { /** @@ -8566,6 +8897,11 @@ export namespace compute_beta { * (== resource_for v1.snapshots ==) */ export interface Schema$Snapshot { + /** + * [Output Only] Set to true if snapshots are autoamtically by applying + * resource policy on the target disk. + */ + autoCreated?: boolean; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -8673,6 +9009,10 @@ export namespace compute_beta { * updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. */ storageBytesStatus?: string; + /** + * GCS bucket storage location of the snapshot (regional or multi-regional). + */ + storageLocations?: string[]; } /** * Contains a list of Snapshot resources. @@ -8910,7 +9250,8 @@ export namespace compute_beta { * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. This field will be * ignored when inserting a SslPolicy. An up-to-date fingerprint must be - * provided in order to update the SslPolicy. + * provided in order to update the SslPolicy. To see the latest + * fingerprint, make a get() request to retrieve an SslPolicy. */ fingerprint?: string; /** @@ -8999,7 +9340,8 @@ export namespace compute_beta { * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. This field will be * ignored when inserting a Subnetwork. An up-to-date fingerprint must be - * provided in order to update the Subnetwork. + * provided in order to update the Subnetwork. To see the latest + * fingerprint, make a get() request to retrieve a Subnetwork. */ fingerprint?: string; /** @@ -9984,7 +10326,7 @@ export namespace compute_beta { * changes after every request to modify or update labels. You must always * provide an up-to-date fingerprint hash in order to update or change * labels. To see the latest fingerprint, make a get() request to retrieve - * an TargetVpnGateway. + * a TargetVpnGateway. */ labelFingerprint?: string; /** @@ -10116,6 +10458,17 @@ export namespace compute_beta { * port_name are defined, port takes precedence. */ portName?: string; + /** + * Specifies how port is selected for health checking, can be one of + * following values: USE_FIXED_PORT: The port number in port is used for + * health checking. USE_NAMED_PORT: The portName is used for health + * checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified + * for each network endpoint is used for health checking. For other + * backends, the port or named port specified in the Backend Service is used + * for health checking. If not specified, TCP health check follows + * behavior specified in port and portName fields. + */ + portSpecification?: string; /** * Specifies the type of proxy header to append before sending data to the * backend, either NONE or PROXY_V1. The default is NONE. @@ -10201,7 +10554,8 @@ export namespace compute_beta { * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. This field will be * ignored when inserting a UrlMap. An up-to-date fingerprint must be - * provided in order to update the UrlMap. + * provided in order to update the UrlMap. To see the latest fingerprint, + * make a get() request to retrieve a UrlMap. */ fingerprint?: string; /** @@ -13964,7 +14318,8 @@ export namespace compute_beta { /** * compute.backendBuckets.addSignedUrlKey - * @desc Adds the given Signed URL Key to the backend bucket. + * @desc Adds a key for validating requests with signed URLs for this + * backend bucket. * @alias compute.backendBuckets.addSignedUrlKey * @memberOf! () * @@ -14164,7 +14519,8 @@ export namespace compute_beta { /** * compute.backendBuckets.deleteSignedUrlKey - * @desc Deletes the given Signed URL Key from the backend bucket. + * @desc Deletes a key for validating requests with signed URLs for this + * backend bucket. * @alias compute.backendBuckets.deleteSignedUrlKey * @memberOf! () * @@ -15172,7 +15528,8 @@ export namespace compute_beta { /** * compute.backendServices.addSignedUrlKey - * @desc Adds the given Signed URL Key to the specified backend service. + * @desc Adds a key for validating requests with signed URLs for this + * backend service. * @alias compute.backendServices.addSignedUrlKey * @memberOf! () * @@ -15521,8 +15878,8 @@ export namespace compute_beta { /** * compute.backendServices.deleteSignedUrlKey - * @desc Deletes the given Signed URL Key from the specified backend - * service. + * @desc Deletes a key for validating requests with signed URLs for this + * backend service. * @alias compute.backendServices.deleteSignedUrlKey * @memberOf! () * @@ -17063,6 +17420,81 @@ export namespace compute_beta { } + /** + * compute.disks.addResourcePolicies + * @desc Adds existing resource policies to a disk. You can only add one + * policy which will be applied to this disk for scheduling snapshot + * creation. + * @alias compute.disks.addResourcePolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk The disk name for this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().DisksAddResourcePoliciesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addResourcePolicies( + params?: Params$Resource$Disks$Addresourcepolicies, + options?: MethodOptions): AxiosPromise; + addResourcePolicies( + params: Params$Resource$Disks$Addresourcepolicies, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + addResourcePolicies( + params: Params$Resource$Disks$Addresourcepolicies, + callback: BodyResponseCallback): void; + addResourcePolicies(callback: BodyResponseCallback): void; + addResourcePolicies( + paramsOrCallback?: Params$Resource$Disks$Addresourcepolicies| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Disks$Addresourcepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Addresourcepolicies; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'disk'], + pathParams: ['disk', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.disks.aggregatedList * @desc Retrieves an aggregated list of persistent disks. @@ -17597,6 +18029,77 @@ export namespace compute_beta { } + /** + * compute.disks.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no + * such policy or resource exists. + * @alias compute.disks.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Disks$Getiampolicy, + options?: MethodOptions): AxiosPromise; + getIamPolicy( + params: Params$Resource$Disks$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Disks$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: Params$Resource$Disks$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Disks$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.disks.insert * @desc Creates a persistent disk in the specified project using the data @@ -17871,6 +18374,80 @@ export namespace compute_beta { } + /** + * compute.disks.removeResourcePolicies + * @desc Removes resource policies from a disk. + * @alias compute.disks.removeResourcePolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk The disk name for this request. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().DisksRemoveResourcePoliciesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + removeResourcePolicies( + params?: Params$Resource$Disks$Removeresourcepolicies, + options?: MethodOptions): AxiosPromise; + removeResourcePolicies( + params: Params$Resource$Disks$Removeresourcepolicies, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + removeResourcePolicies( + params: Params$Resource$Disks$Removeresourcepolicies, + callback: BodyResponseCallback): void; + removeResourcePolicies(callback: BodyResponseCallback): + void; + removeResourcePolicies( + paramsOrCallback?: Params$Resource$Disks$Removeresourcepolicies| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Disks$Removeresourcepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Removeresourcepolicies; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'disk'], + pathParams: ['disk', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.disks.resize * @desc Resizes the specified persistent disk. You can only increase the @@ -18006,6 +18583,78 @@ export namespace compute_beta { } + /** + * compute.disks.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias compute.disks.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {().ZoneSetPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Disks$Setiampolicy, + options?: MethodOptions): AxiosPromise; + setIamPolicy( + params: Params$Resource$Disks$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: Params$Resource$Disks$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: Params$Resource$Disks$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Disks$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.disks.setLabels * @desc Sets the labels on a disk. To learn more about labels, read the @@ -18279,6 +18928,43 @@ export namespace compute_beta { } } + export interface Params$Resource$Disks$Addresourcepolicies { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The disk name for this request. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DisksAddResourcePoliciesRequest; + } export interface Params$Resource$Disks$Aggregatedlist { /** * Auth client or API Key for the request @@ -18425,6 +19111,25 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Disks$Getiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } export interface Params$Resource$Disks$Insert { /** * Auth client or API Key for the request @@ -18520,6 +19225,43 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Disks$Removeresourcepolicies { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The disk name for this request. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DisksRemoveResourcePoliciesRequest; + } export interface Params$Resource$Disks$Resize { /** * Auth client or API Key for the request @@ -18557,6 +19299,30 @@ export namespace compute_beta { */ requestBody?: Schema$DisksResizeRequest; } + export interface Params$Resource$Disks$Setiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ZoneSetPolicyRequest; + } export interface Params$Resource$Disks$Setlabels { /** * Auth client or API Key for the request @@ -28423,6 +29189,76 @@ export namespace compute_beta { } + /** + * compute.images.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no + * such policy or resource exists. + * @alias compute.images.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Images$Getiampolicy, + options?: MethodOptions): AxiosPromise; + getIamPolicy( + params: Params$Resource$Images$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Images$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: Params$Resource$Images$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Images$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/global/images/{resource}/getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.images.insert * @desc Creates an image in the specified project using the data included @@ -28689,6 +29525,77 @@ export namespace compute_beta { } + /** + * compute.images.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias compute.images.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {().GlobalSetPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Images$Setiampolicy, + options?: MethodOptions): AxiosPromise; + setIamPolicy( + params: Params$Resource$Images$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: Params$Resource$Images$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: Params$Resource$Images$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Images$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Images$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/global/images/{resource}/setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.images.setLabels * @desc Sets the labels on an image. To learn more about labels, read the @@ -29044,6 +29951,21 @@ export namespace compute_beta { */ project?: string; } + export interface Params$Resource$Images$Getiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + } export interface Params$Resource$Images$Insert { /** * Auth client or API Key for the request @@ -29131,6 +30053,26 @@ export namespace compute_beta { */ project?: string; } + export interface Params$Resource$Images$Setiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetPolicyRequest; + } export interface Params$Resource$Images$Setlabels { /** * Auth client or API Key for the request @@ -30269,11 +31211,11 @@ export namespace compute_beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). * @param {string} params.instanceGroupManager The name of the managed instance group. - * @param {integer=} params.maxResults - * @param {string=} params.order_by - * @param {string=} params.pageToken + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {string} params.zone The name of the zone where the managed instance group is located. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -31909,7 +32851,22 @@ export namespace compute_beta { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -31917,15 +32874,27 @@ export namespace compute_beta { */ instanceGroupManager?: string; /** - * + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) */ maxResults?: number; /** - * + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. */ order_by?: string; /** - * + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -35033,6 +36002,77 @@ export namespace compute_beta { } + /** + * compute.instances.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no + * such policy or resource exists. + * @alias compute.instances.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Instances$Getiampolicy, + options?: MethodOptions): AxiosPromise; + getIamPolicy( + params: Params$Resource$Instances$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Instances$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: Params$Resource$Instances$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Instances$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.instances.getSerialPortOutput * @desc Returns the specified instance's serial port output. @@ -35989,6 +37029,78 @@ export namespace compute_beta { } + /** + * compute.instances.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias compute.instances.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {().ZoneSetPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Instances$Setiampolicy, + options?: MethodOptions): AxiosPromise; + setIamPolicy( + params: Params$Resource$Instances$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: Params$Resource$Instances$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: Params$Resource$Instances$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Instances$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.instances.setLabels * @desc Sets labels on an instance. To learn more about labels, read the @@ -38394,6 +39506,25 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Instances$Getiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } export interface Params$Resource$Instances$Getserialportoutput { /** * Auth client or API Key for the request @@ -38696,6 +39827,30 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Instances$Setiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ZoneSetPolicyRequest; + } export interface Params$Resource$Instances$Setlabels { /** * Auth client or API Key for the request @@ -39560,6 +40715,76 @@ export namespace compute_beta { } + /** + * compute.instanceTemplates.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no + * such policy or resource exists. + * @alias compute.instanceTemplates.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Instancetemplates$Getiampolicy, + options?: MethodOptions): AxiosPromise; + getIamPolicy( + params: Params$Resource$Instancetemplates$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Instancetemplates$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: Params$Resource$Instancetemplates$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Instancetemplates$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/global/instanceTemplates/{resource}/getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.instanceTemplates.insert * @desc Creates an instance template in the specified project using the @@ -39831,6 +41056,77 @@ export namespace compute_beta { } + /** + * compute.instanceTemplates.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias compute.instanceTemplates.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {().GlobalSetPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Instancetemplates$Setiampolicy, + options?: MethodOptions): AxiosPromise; + setIamPolicy( + params: Params$Resource$Instancetemplates$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: Params$Resource$Instancetemplates$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: Params$Resource$Instancetemplates$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Instancetemplates$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancetemplates$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/global/instanceTemplates/{resource}/setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.instanceTemplates.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. @@ -40005,6 +41301,21 @@ export namespace compute_beta { */ project?: string; } + export interface Params$Resource$Instancetemplates$Getiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + } export interface Params$Resource$Instancetemplates$Insert { /** * Auth client or API Key for the request @@ -40088,6 +41399,26 @@ export namespace compute_beta { */ project?: string; } + export interface Params$Resource$Instancetemplates$Setiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetPolicyRequest; + } export interface Params$Resource$Instancetemplates$Testiampermissions { /** * Auth client or API Key for the request @@ -46562,7 +47893,8 @@ export namespace compute_beta { /** * compute.nodeGroups.aggregatedList - * @desc Retrieves an aggregated list of node groups. + * @desc Retrieves an aggregated list of node groups. Note: use + * nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.aggregatedList * @memberOf! () * @@ -46781,7 +48113,8 @@ export namespace compute_beta { /** * compute.nodeGroups.get * @desc Returns the specified NodeGroup. Get a list of available NodeGroups - * by making a list() request. + * by making a list() request. Note: the "nodes" field should not be used. + * Use nodeGroups.listNodes instead. * @alias compute.nodeGroups.get * @memberOf! () * @@ -46991,6 +48324,7 @@ export namespace compute_beta { /** * compute.nodeGroups.list * @desc Retrieves a list of node groups available to the specified project. + * Note: use nodeGroups.listNodes for more details about each group. * @alias compute.nodeGroups.list * @memberOf! () * @@ -47059,6 +48393,81 @@ export namespace compute_beta { } + /** + * compute.nodeGroups.listNodes + * @desc Lists nodes in the node group. + * @alias compute.nodeGroups.listNodes + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string} params.nodeGroup Name of the NodeGroup resource whose nodes you want to list. + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listNodes( + params?: Params$Resource$Nodegroups$Listnodes, + options?: MethodOptions): AxiosPromise; + listNodes( + params: Params$Resource$Nodegroups$Listnodes, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + listNodes( + params: Params$Resource$Nodegroups$Listnodes, + callback: BodyResponseCallback): void; + listNodes(callback: BodyResponseCallback): void; + listNodes( + paramsOrCallback?: Params$Resource$Nodegroups$Listnodes| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Nodegroups$Listnodes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Listnodes; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.nodeGroups.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces @@ -47571,6 +48980,68 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Nodegroups$Listnodes { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Name of the NodeGroup resource whose nodes you want to list. + */ + nodeGroup?: string; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } export interface Params$Resource$Nodegroups$Setiampolicy { /** * Auth client or API Key for the request @@ -49693,10 +51164,10 @@ export namespace compute_beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter - * @param {integer=} params.maxResults - * @param {string=} params.order_by - * @param {string=} params.pageToken + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -49838,10 +51309,10 @@ export namespace compute_beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter - * @param {integer=} params.maxResults - * @param {string=} params.order_by - * @param {string=} params.pageToken + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {().ProjectsListXpnHostsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -50620,19 +52091,46 @@ export namespace compute_beta { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) */ maxResults?: number; /** - * + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. */ order_by?: string; /** - * + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -50647,19 +52145,46 @@ export namespace compute_beta { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) */ maxResults?: number; /** - * + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. */ order_by?: string; /** - * + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -54127,6 +55652,81 @@ export namespace compute_beta { } + /** + * compute.regionDisks.addResourcePolicies + * @desc Adds existing resource policies to a regional disk. You can only + * add one policy which will be applied to this disk for scheduling snapshot + * creation. + * @alias compute.regionDisks.addResourcePolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk The disk name for this request. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().RegionDisksAddResourcePoliciesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addResourcePolicies( + params?: Params$Resource$Regiondisks$Addresourcepolicies, + options?: MethodOptions): AxiosPromise; + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + addResourcePolicies( + params: Params$Resource$Regiondisks$Addresourcepolicies, + callback: BodyResponseCallback): void; + addResourcePolicies(callback: BodyResponseCallback): void; + addResourcePolicies( + paramsOrCallback?: Params$Resource$Regiondisks$Addresourcepolicies| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regiondisks$Addresourcepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Addresourcepolicies; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.regionDisks.createSnapshot * @desc Creates a snapshot of this regional disk. @@ -54484,6 +56084,80 @@ export namespace compute_beta { } + /** + * compute.regionDisks.removeResourcePolicies + * @desc Removes resource policies from a regional disk. + * @alias compute.regionDisks.removeResourcePolicies + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.disk The disk name for this request. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().RegionDisksRemoveResourcePoliciesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + removeResourcePolicies( + params?: Params$Resource$Regiondisks$Removeresourcepolicies, + options?: MethodOptions): AxiosPromise; + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + removeResourcePolicies( + params: Params$Resource$Regiondisks$Removeresourcepolicies, + callback: BodyResponseCallback): void; + removeResourcePolicies(callback: BodyResponseCallback): + void; + removeResourcePolicies( + paramsOrCallback?: Params$Resource$Regiondisks$Removeresourcepolicies| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Regiondisks$Removeresourcepolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regiondisks$Removeresourcepolicies; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region', 'disk'], + pathParams: ['disk', 'project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.regionDisks.resize * @desc Resizes the specified regional persistent disk. @@ -54704,6 +56378,43 @@ export namespace compute_beta { } } + export interface Params$Resource$Regiondisks$Addresourcepolicies { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The disk name for this request. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionDisksAddResourcePoliciesRequest; + } export interface Params$Resource$Regiondisks$Createsnapshot { /** * Auth client or API Key for the request @@ -54887,6 +56598,43 @@ export namespace compute_beta { */ region?: string; } + export interface Params$Resource$Regiondisks$Removeresourcepolicies { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The disk name for this request. + */ + disk?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionDisksRemoveResourcePoliciesRequest; + } export interface Params$Resource$Regiondisks$Resize { /** * Auth client or API Key for the request @@ -56159,11 +57907,11 @@ export namespace compute_beta { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). * @param {string} params.instanceGroupManager The name of the managed instance group. - * @param {integer=} params.maxResults - * @param {string=} params.order_by - * @param {string=} params.pageToken + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -57597,7 +59345,22 @@ export namespace compute_beta { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -57605,15 +59368,27 @@ export namespace compute_beta { */ instanceGroupManager?: string; /** - * + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) */ maxResults?: number; /** - * + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. */ order_by?: string; /** - * + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -59685,6 +61460,682 @@ export namespace compute_beta { } + export class Resource$Resourcepolicies { + root: Compute; + constructor(root: Compute) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * compute.resourcePolicies.aggregatedList + * @desc Retrieves an aggregated list of resource policies. + * @alias compute.resourcePolicies.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Resourcepolicies$Aggregatedlist, + options?: MethodOptions): + AxiosPromise; + aggregatedList( + params: Params$Resource$Resourcepolicies$Aggregatedlist, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + aggregatedList( + params: Params$Resource$Resourcepolicies$Aggregatedlist, + callback: BodyResponseCallback): + void; + aggregatedList( + callback: BodyResponseCallback): + void; + aggregatedList( + paramsOrCallback?: Params$Resource$Resourcepolicies$Aggregatedlist| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Resourcepolicies$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/aggregated/resourcePolicies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * compute.resourcePolicies.delete + * @desc Deletes the specified resource policy. + * @alias compute.resourcePolicies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.resourcePolicy Name of the resource policy to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Resourcepolicies$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Resourcepolicies$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Resourcepolicies$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Resourcepolicies$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Resourcepolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['project', 'region', 'resourcePolicy'], + pathParams: ['project', 'region', 'resourcePolicy'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.resourcePolicies.get + * @desc Retrieves all information of the specified resource policy. + * @alias compute.resourcePolicies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string} params.resourcePolicy Name of the resource policy to retrieve. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Resourcepolicies$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Resourcepolicies$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Resourcepolicies$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Resourcepolicies$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Resourcepolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'region', 'resourcePolicy'], + pathParams: ['project', 'region', 'resourcePolicy'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.resourcePolicies.insert + * @desc Creates a new resource policy. + * @alias compute.resourcePolicies.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().ResourcePolicy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Resourcepolicies$Insert, + options?: MethodOptions): AxiosPromise; + insert( + params: Params$Resource$Resourcepolicies$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Resourcepolicies$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Resourcepolicies$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Resourcepolicies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/regions/{region}/resourcePolicies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.resourcePolicies.list + * @desc A list all the resource policies that have been configured for the + * specified project in specified region. + * @alias compute.resourcePolicies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Resourcepolicies$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Resourcepolicies$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Resourcepolicies$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Resourcepolicies$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Resourcepolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/regions/{region}/resourcePolicies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.resourcePolicies.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.resourcePolicies.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {().TestPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Resourcepolicies$Testiampermissions, + options?: MethodOptions): AxiosPromise; + testIamPermissions( + params: Params$Resource$Resourcepolicies$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + testIamPermissions( + params: Params$Resource$Resourcepolicies$Testiampermissions, + callback: BodyResponseCallback): void; + testIamPermissions( + callback: BodyResponseCallback): void; + testIamPermissions( + paramsOrCallback?: Params$Resource$Resourcepolicies$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Resourcepolicies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Resourcepolicies$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Resourcepolicies$Aggregatedlist { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Resourcepolicies$Delete { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the resource policy to delete. + */ + resourcePolicy?: string; + } + export interface Params$Resource$Resourcepolicies$Get { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Name of the resource policy to retrieve. + */ + resourcePolicy?: string; + } + export interface Params$Resource$Resourcepolicies$Insert { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResourcePolicy; + } + export interface Params$Resource$Resourcepolicies$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Resourcepolicies$Testiampermissions { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Routers { root: Compute; constructor(root: Compute) { @@ -63936,6 +66387,76 @@ export namespace compute_beta { } + /** + * compute.snapshots.getIamPolicy + * @desc Gets the access control policy for a resource. May be empty if no + * such policy or resource exists. + * @alias compute.snapshots.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Snapshots$Getiampolicy, + options?: MethodOptions): AxiosPromise; + getIamPolicy( + params: Params$Resource$Snapshots$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Snapshots$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: Params$Resource$Snapshots$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Snapshots$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/global/snapshots/{resource}/getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.snapshots.list * @desc Retrieves the list of Snapshot resources contained within the @@ -64073,6 +66594,77 @@ export namespace compute_beta { } + /** + * compute.snapshots.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias compute.snapshots.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.resource_ Name of the resource for this request. + * @param {().GlobalSetPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Snapshots$Setiampolicy, + options?: MethodOptions): AxiosPromise; + setIamPolicy( + params: Params$Resource$Snapshots$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: Params$Resource$Snapshots$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: Params$Resource$Snapshots$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Snapshots$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Snapshots$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/beta/projects/{project}/global/snapshots/{resource}/setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.snapshots.setLabels * @desc Sets the labels on a snapshot. To learn more about labels, read the @@ -64381,6 +66973,21 @@ export namespace compute_beta { */ snapshot?: string; } + export interface Params$Resource$Snapshots$Getiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + } export interface Params$Resource$Snapshots$List { /** * Auth client or API Key for the request @@ -64435,6 +67042,26 @@ export namespace compute_beta { */ project?: string; } + export interface Params$Resource$Snapshots$Setiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GlobalSetPolicyRequest; + } export interface Params$Resource$Snapshots$Setlabels { /** * Auth client or API Key for the request diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index 3e0a24499f3..4ba28af9764 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -77,6 +77,9 @@ export namespace compute_v1 { licenses: Resource$Licenses; machineTypes: Resource$Machinetypes; networks: Resource$Networks; + nodeGroups: Resource$Nodegroups; + nodeTemplates: Resource$Nodetemplates; + nodeTypes: Resource$Nodetypes; projects: Resource$Projects; regionAutoscalers: Resource$Regionautoscalers; regionBackendServices: Resource$Regionbackendservices; @@ -137,6 +140,9 @@ export namespace compute_v1 { this.licenses = new Resource$Licenses(this); this.machineTypes = new Resource$Machinetypes(this); this.networks = new Resource$Networks(this); + this.nodeGroups = new Resource$Nodegroups(this); + this.nodeTemplates = new Resource$Nodetemplates(this); + this.nodeTypes = new Resource$Nodetypes(this); this.projects = new Resource$Projects(this); this.regionAutoscalers = new Resource$Regionautoscalers(this); this.regionBackendServices = new Resource$Regionbackendservices(this); @@ -336,6 +342,15 @@ export namespace compute_v1 { * the zone of the instance. */ natIP?: string; + /** + * This signifies the networking tier used for configuring this access + * configuration and can only take the following values: PREMIUM, STANDARD. + * If an AccessConfig is specified without a valid external IP address, an + * ephemeral IP will be created with this networkTier. If an AccessConfig + * with a valid external IP address is specified, it must match that of the + * networkTier associated with the Address resource owning that IP. + */ + networkTier?: string; /** * The DNS domain name for the public PTR record. This field can only be set * when the set_public_ptr field is enabled. @@ -399,6 +414,12 @@ export namespace compute_v1 { * dash. */ name?: string; + /** + * This signifies the networking tier used for configuring this Address and + * can only take the following values: PREMIUM , STANDARD. If this field is + * not specified, it is assumed to be PREMIUM. + */ + networkTier?: string; /** * [Output Only] URL of the region where the regional address resides. This * field is not applicable to global addresses. You must specify this field @@ -635,7 +656,8 @@ export namespace compute_v1 { export interface Schema$AttachedDiskInitializeParams { /** * Specifies the disk name. If not specified, the default is to use the name - * of the instance. + * of the instance. If the disk with the instance name exists already in the + * given zone/region, a new name will be automatically generated. */ diskName?: string; /** @@ -1027,6 +1049,10 @@ export namespace compute_v1 { * Cloud Storage bucket name. */ bucketName?: string; + /** + * Cloud CDN configuration for this BackendBucket. + */ + cdnPolicy?: Schema$BackendBucketCdnPolicy; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -1063,6 +1089,25 @@ export namespace compute_v1 { */ selfLink?: string; } + /** + * Message containing Cloud CDN configuration for a backend bucket. + */ + export interface Schema$BackendBucketCdnPolicy { + /** + * Maximum number of seconds the response to a signed URL request will be + * considered fresh. After this time period, the response will be + * revalidated before being served. Defaults to 1hr (3600s). When serving + * responses to signed URL requests, Cloud CDN will internally behave as + * though all responses from this backend had a ?Cache-Control: public, + * max-age=[TTL]? header, regardless of any existing Cache-Control header. + * The actual headers served in responses will not be altered. + */ + signedUrlCacheMaxAgeSec?: string; + /** + * [Output Only] Names of the keys for signing request URLs. + */ + signedUrlKeyNames?: string[]; + } /** * Contains a list of BackendBucket resources. */ @@ -1137,7 +1182,8 @@ export namespace compute_v1 { * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. This field will be * ignored when inserting a BackendService. An up-to-date fingerprint must - * be provided in order to update the BackendService. + * be provided in order to update the BackendService. To see the latest + * fingerprint, make a get() request to retrieve a BackendService. */ fingerprint?: string; /** @@ -1263,6 +1309,20 @@ export namespace compute_v1 { * The CacheKeyPolicy for this CdnPolicy. */ cacheKeyPolicy?: Schema$CacheKeyPolicy; + /** + * Maximum number of seconds the response to a signed URL request will be + * considered fresh. After this time period, the response will be + * revalidated before being served. Defaults to 1hr (3600s). When serving + * responses to signed URL requests, Cloud CDN will internally behave as + * though all responses from this backend had a ?Cache-Control: public, + * max-age=[TTL]? header, regardless of any existing Cache-Control header. + * The actual headers served in responses will not be altered. + */ + signedUrlCacheMaxAgeSec?: string; + /** + * [Output Only] Names of the keys for signing request URLs. + */ + signedUrlKeyNames?: string[]; } export interface Schema$BackendServiceGroupHealth { healthStatus?: Schema$HealthStatus[]; @@ -2048,6 +2108,20 @@ export namespace compute_v1 { */ warning?: any; } + export interface Schema$DistributionPolicy { + /** + * Zones where the regional managed instance group will create and manage + * instances. + */ + zones?: Schema$DistributionPolicyZoneConfiguration[]; + } + export interface Schema$DistributionPolicyZoneConfiguration { + /** + * The URL of the zone. The zone must exist in the region where the managed + * instance group is located. + */ + zone?: string; + } /** * Represents a Firewall resource. */ @@ -2230,7 +2304,7 @@ export namespace compute_v1 { */ export interface Schema$ForwardingRule { /** - * This field is not used for external load balancing. For internal load + * This field is only used for INTERNAL load balancing. For internal load * balancing, this field identifies the BackendService resource to receive * the matched traffic. */ @@ -2259,12 +2333,14 @@ export namespace compute_v1 { * field is empty, an ephemeral IPv4 address from the same scope (global or * regional) will be assigned. A regional forwarding rule supports IPv4 * only. A global forwarding rule supports either IPv4 or IPv6. When the - * load balancing scheme is INTERNAL, this can only be an RFC 1918 IP - * address belonging to the network/subnet configured for the forwarding - * rule. By default, if this field is empty, an ephemeral internal IP - * address will be automatically allocated from the IP range of the subnet - * or network configured for this forwarding rule. An address can be - * specified either by a literal IP address or a URL reference to an + * load balancing scheme is INTERNAL_SELF_MANAGED, this must be a URL + * reference to an existing Address resource ( internal regional static IP + * address). When the load balancing scheme is INTERNAL, this can only be + * an RFC 1918 IP address belonging to the network/subnet configured for the + * forwarding rule. By default, if this field is empty, an ephemeral + * internal IP address will be automatically allocated from the IP range of + * the subnet or network configured for this forwarding rule. An address + * can be specified either by a literal IP address or a URL reference to an * existing Address resource. The following examples are all valid: - * 100.1.2.3 - * https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address @@ -2275,13 +2351,14 @@ export namespace compute_v1 { /** * The IP protocol to which this rule applies. Valid options are TCP, UDP, * ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only - * TCP and UDP are valid. + * TCP and UDP are valid. When the load balancing scheme is + * INTERNAL_SELF_MANAGED, only TCPis valid. */ IPProtocol?: string; /** * The IP Version that will be used by this forwarding rule. Valid options - * are IPV4 or IPV6. This can only be specified for a global forwarding - * rule. + * are IPV4 or IPV6. This can only be specified for an external global + * forwarding rule. */ ipVersion?: string; /** @@ -2291,10 +2368,12 @@ export namespace compute_v1 { kind?: string; /** * This signifies what the ForwardingRule will be used for and can only take - * the following values: INTERNAL, EXTERNAL The value of INTERNAL means that - * this will be used for Internal Network Load Balancing (TCP, UDP). The - * value of EXTERNAL means that this will be used for External Load - * Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) + * the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The + * value of INTERNAL means that this will be used for Internal Network Load + * Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this + * will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means + * that this will be used for External Load Balancing (HTTP(S) LB, External + * TCP/UDP LB, SSL Proxy) */ loadBalancingScheme?: string; /** @@ -2308,12 +2387,21 @@ export namespace compute_v1 { */ name?: string; /** - * This field is not used for external load balancing. For internal load - * balancing, this field identifies the network that the load balanced IP - * should belong to for this Forwarding Rule. If this field is not - * specified, the default network will be used. + * This field is not used for external load balancing. For INTERNAL and + * INTERNAL_SELF_MANAGED load balancing, this field identifies the network + * that the load balanced IP should belong to for this Forwarding Rule. If + * this field is not specified, the default network will be used. */ network?: string; + /** + * This signifies the networking tier used for configuring this load + * balancer and can only take the following values: PREMIUM , STANDARD. For + * regional ForwardingRule, the valid values are PREMIUM and STANDARD. For + * GlobalForwardingRule, the valid value is PREMIUM. If this field is not + * specified, it is assumed to be PREMIUM. If IPAddress is specified, this + * value must be equal to the networkTier of the Address. + */ + networkTier?: string; /** * This field is used along with the target field for TargetHttpProxy, * TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, @@ -2348,7 +2436,7 @@ export namespace compute_v1 { */ selfLink?: string; /** - * This field is not used for external load balancing. For internal load + * This field is only used for INTERNAL load balancing. For internal load * balancing, this field identifies the subnetwork that the load balanced IP * should belong to for this Forwarding Rule. If the network specified is * in auto subnet mode, this field is optional. However, if the network is @@ -2360,7 +2448,8 @@ export namespace compute_v1 { * regional forwarding rules, this target must live in the same region as * the forwarding rule. For global forwarding rules, this target must be a * global load balancing resource. The forwarded traffic must be of a type - * appropriate to the target object. + * appropriate to the target object. For INTERNAL_SELF_MANAGED" load + * balancing, only HTTP and HTTPS targets are valid. */ target?: string; } @@ -3012,9 +3101,9 @@ export namespace compute_v1 { */ sourceDiskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * The ID value of the disk used to create this image. This value may be - * used to determine whether the image was taken from the current or a - * previous instance of a given disk name. + * [Output Only] The ID value of the disk used to create this image. This + * value may be used to determine whether the image was taken from the + * current or a previous instance of a given disk name. */ sourceDiskId?: string; /** @@ -3452,11 +3541,17 @@ export namespace compute_v1 { * create the resource. */ description?: string; + /** + * Policy specifying intended distribution of instances in regional managed + * instance group. + */ + distributionPolicy?: Schema$DistributionPolicy; /** * Fingerprint of this resource. This field may be used in optimistic * locking. It will be ignored when inserting an InstanceGroupManager. An * up-to-date fingerprint must be provided in order to update the - * InstanceGroupManager. + * InstanceGroupManager. To see the latest fingerprint, make a get() + * request to retrieve an InstanceGroupManager. */ fingerprint?: string; /** @@ -5074,7 +5169,9 @@ export namespace compute_v1 { * the metadata's contents and used for optimistic locking. The * fingerprint is initially generated by Compute Engine and changes after * every request to modify or update metadata. You must always provide an - * up-to-date fingerprint hash in order to update or change metadata. + * up-to-date fingerprint hash in order to update or change metadata. To + * see the latest fingerprint, make a get() request to retrieve the + * resource. */ fingerprint?: string; /** @@ -5349,6 +5446,480 @@ export namespace compute_v1 { */ name?: string; } + /** + * A NodeGroup resource. + */ + export interface Schema$NodeGroup { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string; + /** + * An optional description of this resource. Provide this property when you + * create the resource. + */ + description?: string; + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id?: string; + /** + * [Output Only] The type of the resource. Always compute#nodeGroup for node + * group. + */ + kind?: string; + /** + * The name of the resource, provided by the client when initially creating + * the resource. The resource name must be 1-63 characters long, and comply + * with RFC1035. Specifically, the name must be 1-63 characters long and + * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the + * first character must be a lowercase letter, and all following characters + * must be a dash, lowercase letter, or digit, except the last character, + * which cannot be a dash. + */ + name?: string; + /** + * The URL of the node template to which this node group belongs. + */ + nodeTemplate?: string; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string; + /** + * [Output Only] The total number of nodes in the node group. + */ + size?: number; + status?: string; + /** + * [Output Only] The name of the zone where the node group resides, such as + * us-central1-a. + */ + zone?: string; + } + export interface Schema$NodeGroupAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of NodeGroupsScopedList resources. + */ + items?: any; + /** + * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for + * aggregated lists of node groups. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } + /** + * Contains a list of nodeGroups. + */ + export interface Schema$NodeGroupList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of NodeGroup resources. + */ + items?: Schema$NodeGroup[]; + /** + * [Output Only] Type of resource.Always compute#nodeGroupList for lists of + * node groups. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } + export interface Schema$NodeGroupNode { + /** + * Instances scheduled on this node. + */ + instances?: string[]; + /** + * The name of the node. + */ + name?: string; + /** + * The type of this node. + */ + nodeType?: string; + status?: string; + } + export interface Schema$NodeGroupsAddNodesRequest { + /** + * Count of additional nodes to be added to the node group. + */ + additionalNodeCount?: number; + } + export interface Schema$NodeGroupsDeleteNodesRequest { + nodes?: string[]; + } + export interface Schema$NodeGroupsListNodes { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of Node resources. + */ + items?: Schema$NodeGroupNode[]; + /** + * [Output Only] The resource type, which is always + * compute.nodeGroupsListNodes for the list of nodes in the specified node + * group. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } + export interface Schema$NodeGroupsScopedList { + /** + * [Output Only] A list of node groups contained in this scope. + */ + nodeGroups?: Schema$NodeGroup[]; + /** + * [Output Only] An informational warning that appears when the nodeGroup + * list is empty. + */ + warning?: any; + } + export interface Schema$NodeGroupsSetNodeTemplateRequest { + /** + * Full or partial URL of the node template resource to be updated for this + * node group. + */ + nodeTemplate?: string; + } + /** + * A Node Template resource. + */ + export interface Schema$NodeTemplate { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string; + /** + * An optional description of this resource. Provide this property when you + * create the resource. + */ + description?: string; + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id?: string; + /** + * [Output Only] The type of the resource. Always compute#nodeTemplate for + * node templates. + */ + kind?: string; + /** + * The name of the resource, provided by the client when initially creating + * the resource. The resource name must be 1-63 characters long, and comply + * with RFC1035. Specifically, the name must be 1-63 characters long and + * match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the + * first character must be a lowercase letter, and all following characters + * must be a dash, lowercase letter, or digit, except the last charaicter, + * which cannot be a dash. + */ + name?: string; + /** + * Labels to use for node affinity, which will be used in instance + * scheduling. + */ + nodeAffinityLabels?: any; + /** + * The node type to use for nodes group that are created from this template. + */ + nodeType?: string; + /** + * The flexible properties of the desired node type. Node groups that use + * this node template will create nodes of a type that matches these + * properties. This field is mutually exclusive with the node_type + * property; you can only define one or the other, but not both. + */ + nodeTypeFlexibility?: Schema$NodeTemplateNodeTypeFlexibility; + /** + * [Output Only] The name of the region where the node template resides, + * such as us-central1. + */ + region?: string; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string; + /** + * [Output Only] The status of the node template. One of the following + * values: CREATING, READY, and DELETING. + */ + status?: string; + /** + * [Output Only] An optional, human-readable explanation of the status. + */ + statusMessage?: string; + } + export interface Schema$NodeTemplateAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of NodeTemplatesScopedList resources. + */ + items?: any; + /** + * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList + * for aggregated lists of node templates. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } + /** + * Contains a list of node templates. + */ + export interface Schema$NodeTemplateList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of NodeTemplate resources. + */ + items?: Schema$NodeTemplate[]; + /** + * [Output Only] Type of resource.Always compute#nodeTemplateList for lists + * of node templates. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } + export interface Schema$NodeTemplateNodeTypeFlexibility { + cpus?: string; + localSsd?: string; + memory?: string; + } + export interface Schema$NodeTemplatesScopedList { + /** + * [Output Only] A list of node templates contained in this scope. + */ + nodeTemplates?: Schema$NodeTemplate[]; + /** + * [Output Only] An informational warning that appears when the node + * templates list is empty. + */ + warning?: any; + } + /** + * A Node Type resource. + */ + export interface Schema$NodeType { + /** + * [Output Only] The CPU platform used by this node type. + */ + cpuPlatform?: string; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string; + /** + * [Output Only] The deprecation status associated with this node type. + */ + deprecated?: Schema$DeprecationStatus; + /** + * [Output Only] An optional textual description of the resource. + */ + description?: string; + /** + * [Output Only] The number of virtual CPUs that are available to the node + * type. + */ + guestCpus?: number; + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id?: string; + /** + * [Output Only] The type of the resource. Always compute#nodeType for node + * types. + */ + kind?: string; + /** + * [Output Only] Local SSD available to the node type, defined in GB. + */ + localSsdGb?: number; + /** + * [Output Only] The amount of physical memory available to the node type, + * defined in MB. + */ + memoryMb?: number; + /** + * [Output Only] Name of the resource. + */ + name?: string; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string; + /** + * [Output Only] The name of the zone where the node type resides, such as + * us-central1-a. + */ + zone?: string; + } + export interface Schema$NodeTypeAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of NodeTypesScopedList resources. + */ + items?: any; + /** + * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for + * aggregated lists of node types. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } + /** + * Contains a list of node types. + */ + export interface Schema$NodeTypeList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string; + /** + * A list of NodeType resources. + */ + items?: Schema$NodeType[]; + /** + * [Output Only] Type of resource.Always compute#nodeTypeList for lists of + * node types. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } + export interface Schema$NodeTypesScopedList { + /** + * [Output Only] A list of node types contained in this scope. + */ + nodeTypes?: Schema$NodeType[]; + /** + * [Output Only] An informational warning that appears when the node types + * list is empty. + */ + warning?: any; + } /** * An Operation resource, used to manage asynchronous API requests. (== * resource_for v1.globalOperations ==) (== resource_for beta.globalOperations @@ -5619,6 +6190,12 @@ export namespace compute_v1 { * [Output Only] Creation timestamp in RFC3339 text format. */ creationTimestamp?: string; + /** + * This signifies the default network tier used for configuring resources of + * the project and can only take the following values: PREMIUM, STANDARD. + * Initially the default network tier is PREMIUM. + */ + defaultNetworkTier?: string; /** * [Output Only] Default service account used by VMs running in this * project. @@ -5706,6 +6283,12 @@ export namespace compute_v1 { */ organization?: string; } + export interface Schema$ProjectsSetDefaultNetworkTierRequest { + /** + * Default network tier to be set. + */ + networkTier?: string; + } /** * A quotas entry. */ @@ -6613,6 +7196,10 @@ export namespace compute_v1 { * Compute Engine. */ automaticRestart?: boolean; + /** + * A set of node affinity and anti-affinity. + */ + nodeAffinities?: Schema$SchedulingNodeAffinity[]; /** * Defines the maintenance behavior for this instance. For standard * instances, the default behavior is MIGRATE. For preemptible instances, @@ -6627,6 +7214,24 @@ export namespace compute_v1 { */ preemptible?: boolean; } + /** + * Node Affinity: the configuration of desired nodes onto which this Instance + * could be scheduled. + */ + export interface Schema$SchedulingNodeAffinity { + /** + * Corresponds to the label key of Node resource. + */ + key?: string; + /** + * Defines the operation of node selection. + */ + operator?: string; + /** + * Corresponds to the label values of Node resource. + */ + values?: string[]; + } /** * An instance's serial console output. */ @@ -6671,6 +7276,25 @@ export namespace compute_v1 { */ scopes?: string[]; } + /** + * Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs + */ + export interface Schema$SignedUrlKey { + /** + * Name of the key. The name must be 1-63 characters long, and comply with + * RFC1035. Specifically, the name must be 1-63 characters long and match + * the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first + * character must be a lowercase letter, and all following characters must + * be a dash, lowercase letter, or digit, except the last character, which + * cannot be a dash. + */ + keyName?: string; + /** + * 128-bit key value used for signing the URL. The key value must be a valid + * RFC 4648 Section 5 base64url encoded string. + */ + keyValue?: string; + } /** * A persistent disk snapshot resource. (== resource_for beta.snapshots ==) * (== resource_for v1.snapshots ==) @@ -7009,7 +7633,8 @@ export namespace compute_v1 { * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. This field will be * ignored when inserting a SslPolicy. An up-to-date fingerprint must be - * provided in order to update the SslPolicy. + * provided in order to update the SslPolicy. To see the latest + * fingerprint, make a get() request to retrieve an SslPolicy. */ fingerprint?: string; /** @@ -7084,7 +7709,8 @@ export namespace compute_v1 { * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. This field will be * ignored when inserting a Subnetwork. An up-to-date fingerprint must be - * provided in order to update the Subnetwork. + * provided in order to update the Subnetwork. To see the latest + * fingerprint, make a get() request to retrieve a Subnetwork. */ fingerprint?: string; /** @@ -8248,7 +8874,8 @@ export namespace compute_v1 { * Fingerprint of this resource. A hash of the contents stored in this * object. This field is used in optimistic locking. This field will be * ignored when inserting a UrlMap. An up-to-date fingerprint must be - * provided in order to update the UrlMap. + * provided in order to update the UrlMap. To see the latest fingerprint, + * make a get() request to retrieve a UrlMap. */ fingerprint?: string; /** @@ -8372,6 +8999,77 @@ export namespace compute_v1 { */ testPassed?: boolean; } + /** + * Subnetwork which the current user has compute.subnetworks.use permission + * on. + */ + export interface Schema$UsableSubnetwork { + /** + * The range of internal addresses that are owned by this subnetwork. + */ + ipCidrRange?: string; + /** + * Network URL. + */ + network?: string; + /** + * Secondary IP ranges. + */ + secondaryIpRanges?: Schema$UsableSubnetworkSecondaryRange[]; + /** + * Subnetwork URL. + */ + subnetwork?: string; + } + export interface Schema$UsableSubnetworksAggregatedList { + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id?: string; + /** + * [Output] A list of usable subnetwork URLs. + */ + items?: Schema$UsableSubnetwork[]; + /** + * [Output Only] Type of resource. Always + * compute#usableSubnetworksAggregatedList for aggregated lists of usable + * subnetworks. + */ + kind?: string; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger than maxResults, use + * the nextPageToken as a value for the query parameter pageToken in the + * next list request. Subsequent list requests will have their own + * nextPageToken to continue paging through the results. + */ + nextPageToken?: string; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string; + /** + * [Output Only] Informational warning message. + */ + warning?: any; + } + /** + * Secondary IP range of a usable subnetwork. + */ + export interface Schema$UsableSubnetworkSecondaryRange { + /** + * The range of IP addresses belonging to this subnetwork secondary range. + */ + ipCidrRange?: string; + /** + * The name associated with this subnetwork secondary range, used when + * adding an alias IP range to a VM instance. The name must be 1-63 + * characters long, and comply with RFC1035. The name must be unique within + * the subnetwork. + */ + rangeName?: string; + } /** * The location in Cloud Storage and naming method of the daily usage report. * Contains bucket_name and report_name prefix. @@ -11380,6 +12078,79 @@ export namespace compute_v1 { } + /** + * compute.backendBuckets.addSignedUrlKey + * @desc Adds a key for validating requests with signed URLs for this + * backend bucket. + * @alias compute.backendBuckets.addSignedUrlKey + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendBucket Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().SignedUrlKey} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addSignedUrlKey( + params?: Params$Resource$Backendbuckets$Addsignedurlkey, + options?: MethodOptions): AxiosPromise; + addSignedUrlKey( + params: Params$Resource$Backendbuckets$Addsignedurlkey, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + addSignedUrlKey( + params: Params$Resource$Backendbuckets$Addsignedurlkey, + callback: BodyResponseCallback): void; + addSignedUrlKey(callback: BodyResponseCallback): void; + addSignedUrlKey( + paramsOrCallback?: Params$Resource$Backendbuckets$Addsignedurlkey| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Backendbuckets$Addsignedurlkey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$Addsignedurlkey; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'backendBucket'], + pathParams: ['backendBucket', 'project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.backendBuckets.delete * @desc Deletes the specified BackendBucket resource. @@ -11508,6 +12279,79 @@ export namespace compute_v1 { } + /** + * compute.backendBuckets.deleteSignedUrlKey + * @desc Deletes a key for validating requests with signed URLs for this + * backend bucket. + * @alias compute.backendBuckets.deleteSignedUrlKey + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendBucket Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. + * @param {string} params.keyName The name of the Signed URL Key to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deleteSignedUrlKey( + params?: Params$Resource$Backendbuckets$Deletesignedurlkey, + options?: MethodOptions): AxiosPromise; + deleteSignedUrlKey( + params: Params$Resource$Backendbuckets$Deletesignedurlkey, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + deleteSignedUrlKey( + params: Params$Resource$Backendbuckets$Deletesignedurlkey, + callback: BodyResponseCallback): void; + deleteSignedUrlKey(callback: BodyResponseCallback): void; + deleteSignedUrlKey( + paramsOrCallback?: Params$Resource$Backendbuckets$Deletesignedurlkey| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Backendbuckets$Deletesignedurlkey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$Deletesignedurlkey; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'backendBucket', 'keyName'], + pathParams: ['backendBucket', 'project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.backendBuckets.get * @desc Returns the specified BackendBucket resource. Gets a list of @@ -12171,14 +13015,15 @@ export namespace compute_v1 { } } - export interface Params$Resource$Backendbuckets$Delete { + export interface Params$Resource$Backendbuckets$Addsignedurlkey { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Name of the BackendBucket resource to delete. + * Name of the BackendBucket resource to which the Signed URL Key should be + * added. The name should conform to RFC1035. */ backendBucket?: string; /** @@ -12198,28 +13043,55 @@ export namespace compute_v1 { * (00000000-0000-0000-0000-000000000000). */ requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SignedUrlKey; } - export interface Params$Resource$Backendbuckets$Get { + export interface Params$Resource$Backendbuckets$Delete { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Name of the BackendBucket resource to return. + * Name of the BackendBucket resource to delete. */ backendBucket?: string; /** * Project ID for this request. */ project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Backendbuckets$Insert { + export interface Params$Resource$Backendbuckets$Deletesignedurlkey { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * Name of the BackendBucket resource to which the Signed URL Key should be + * added. The name should conform to RFC1035. + */ + backendBucket?: string; + /** + * The name of the Signed URL Key to delete. + */ + keyName?: string; /** * Project ID for this request. */ @@ -12237,76 +13109,115 @@ export namespace compute_v1 { * (00000000-0000-0000-0000-000000000000). */ requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BackendBucket; } - export interface Params$Resource$Backendbuckets$List { + export interface Params$Resource$Backendbuckets$Get { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * A filter expression that filters resources listed in the response. The - * expression must specify the field name, a comparison operator, and the - * value that you want to use for filtering. The value must be a string, a - * number, or a boolean. The comparison operator must be either =, !=, >, or - * <. For example, if you are filtering Compute Engine instances, you can - * exclude instances named example-instance by specifying name != - * example-instance. You can also filter nested fields. For example, you - * could specify scheduling.automaticRestart = false to include instances - * only if they are not scheduled for automatic restarts. You can use - * filtering on nested fields to filter based on resource labels. To filter - * on multiple expressions, provide each separate expression within - * parentheses. For example, (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND - * expression. However, you can include AND and OR expressions explicitly. - * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel - * Broadwell") AND (scheduling.automaticRestart = true). - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the - * number of available results is larger than maxResults, Compute Engine - * returns a nextPageToken that can be used to get the next page of results - * in subsequent list requests. Acceptable values are 0 to 500, inclusive. - * (Default: 500) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned - * in alphanumerical order based on the resource name. You can also sort - * results in descending order based on the creation timestamp using - * orderBy="creationTimestamp desc". This sorts results based on the - * creationTimestamp field in reverse chronological order (newest result - * first). Use this to sort resources like operations so that the newest - * operation is returned first. Currently, only sorting by name or - * creationTimestamp desc is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set pageToken to the nextPageToken - * returned by a previous list request to get the next page of results. + * Name of the BackendBucket resource to return. */ - pageToken?: string; + backendBucket?: string; /** * Project ID for this request. */ project?: string; } - export interface Params$Resource$Backendbuckets$Patch { + export interface Params$Resource$Backendbuckets$Insert { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - /** - * Name of the BackendBucket resource to patch. - */ - backendBucket?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendBucket; + } + export interface Params$Resource$Backendbuckets$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Backendbuckets$Patch { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the BackendBucket resource to patch. + */ + backendBucket?: string; /** * Project ID for this request. */ @@ -12377,6 +13288,79 @@ export namespace compute_v1 { } + /** + * compute.backendServices.addSignedUrlKey + * @desc Adds a key for validating requests with signed URLs for this + * backend service. + * @alias compute.backendServices.addSignedUrlKey + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().SignedUrlKey} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addSignedUrlKey( + params?: Params$Resource$Backendservices$Addsignedurlkey, + options?: MethodOptions): AxiosPromise; + addSignedUrlKey( + params: Params$Resource$Backendservices$Addsignedurlkey, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + addSignedUrlKey( + params: Params$Resource$Backendservices$Addsignedurlkey, + callback: BodyResponseCallback): void; + addSignedUrlKey(callback: BodyResponseCallback): void; + addSignedUrlKey( + paramsOrCallback?: Params$Resource$Backendservices$Addsignedurlkey| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Backendservices$Addsignedurlkey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$Addsignedurlkey; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/global/backendServices/{backendService}/addSignedUrlKey') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'backendService'], + pathParams: ['backendService', 'project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.backendServices.aggregatedList * @desc Retrieves the list of all BackendService resources, regional and @@ -12653,6 +13637,79 @@ export namespace compute_v1 { } + /** + * compute.backendServices.deleteSignedUrlKey + * @desc Deletes a key for validating requests with signed URLs for this + * backend service. + * @alias compute.backendServices.deleteSignedUrlKey + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.backendService Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. + * @param {string} params.keyName The name of the Signed URL Key to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deleteSignedUrlKey( + params?: Params$Resource$Backendservices$Deletesignedurlkey, + options?: MethodOptions): AxiosPromise; + deleteSignedUrlKey( + params: Params$Resource$Backendservices$Deletesignedurlkey, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + deleteSignedUrlKey( + params: Params$Resource$Backendservices$Deletesignedurlkey, + callback: BodyResponseCallback): void; + deleteSignedUrlKey(callback: BodyResponseCallback): void; + deleteSignedUrlKey( + paramsOrCallback?: Params$Resource$Backendservices$Deletesignedurlkey| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Backendservices$Deletesignedurlkey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$Deletesignedurlkey; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'backendService', 'keyName'], + pathParams: ['backendService', 'project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.backendServices.get * @desc Returns the specified BackendService resource. Gets a list of @@ -13458,6 +14515,40 @@ export namespace compute_v1 { } } + export interface Params$Resource$Backendservices$Addsignedurlkey { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the BackendService resource to which the Signed URL Key should be + * added. The name should conform to RFC1035. + */ + backendService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SignedUrlKey; + } export interface Params$Resource$Backendservices$Aggregatedlist { /** * Auth client or API Key for the request @@ -13540,6 +14631,39 @@ export namespace compute_v1 { */ requestId?: string; } + export interface Params$Resource$Backendservices$Deletesignedurlkey { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the BackendService resource to which the Signed URL Key should be + * added. The name should conform to RFC1035. + */ + backendService?: string; + /** + * The name of the Signed URL Key to delete. + */ + keyName?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } export interface Params$Resource$Backendservices$Get { /** * Auth client or API Key for the request @@ -25059,11 +26183,11 @@ export namespace compute_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). * @param {string} params.instanceGroupManager The name of the managed instance group. - * @param {integer=} params.maxResults - * @param {string=} params.order_by - * @param {string=} params.pageToken + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {string} params.zone The name of the zone where the managed instance group is located. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -25991,7 +27115,22 @@ export namespace compute_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -25999,15 +27138,27 @@ export namespace compute_v1 { */ instanceGroupManager?: string; /** - * + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) */ maxResults?: number; /** - * + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. */ order_by?: string; /** - * + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -37719,99 +38870,2070 @@ export namespace compute_v1 { */ project?: string; } - export interface Params$Resource$Networks$Patch { + export interface Params$Resource$Networks$Patch { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the network to update. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Network; + } + export interface Params$Resource$Networks$Removepeering { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the network resource to remove peering from. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworksRemovePeeringRequest; + } + export interface Params$Resource$Networks$Switchtocustommode { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the network to be updated. + */ + network?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + + + export class Resource$Nodegroups { + root: Compute; + constructor(root: Compute) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * compute.nodeGroups.addNodes + * @desc Adds specified number of nodes to the node group. + * @alias compute.nodeGroups.addNodes + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the NodeGroup resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().NodeGroupsAddNodesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addNodes( + params?: Params$Resource$Nodegroups$Addnodes, + options?: MethodOptions): AxiosPromise; + addNodes( + params: Params$Resource$Nodegroups$Addnodes, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + addNodes( + params: Params$Resource$Nodegroups$Addnodes, + callback: BodyResponseCallback): void; + addNodes(callback: BodyResponseCallback): void; + addNodes( + paramsOrCallback?: Params$Resource$Nodegroups$Addnodes| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Nodegroups$Addnodes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Addnodes; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeGroups.aggregatedList + * @desc Retrieves an aggregated list of node groups. Note: use + * nodeGroups.listNodes for more details about each group. + * @alias compute.nodeGroups.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Nodegroups$Aggregatedlist, + options?: MethodOptions): AxiosPromise; + aggregatedList( + params: Params$Resource$Nodegroups$Aggregatedlist, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + aggregatedList( + params: Params$Resource$Nodegroups$Aggregatedlist, + callback: BodyResponseCallback): void; + aggregatedList( + callback: BodyResponseCallback): void; + aggregatedList( + paramsOrCallback?: Params$Resource$Nodegroups$Aggregatedlist| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Nodegroups$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/compute/v1/projects/{project}/aggregated/nodeGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeGroups.delete + * @desc Deletes the specified NodeGroup resource. + * @alias compute.nodeGroups.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the NodeGroup resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete(params?: Params$Resource$Nodegroups$Delete, options?: MethodOptions): + AxiosPromise; + delete( + params: Params$Resource$Nodegroups$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Nodegroups$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Nodegroups$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Nodegroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeGroups.deleteNodes + * @desc Deletes specified nodes from the node group. + * @alias compute.nodeGroups.deleteNodes + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the NodeGroup resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().NodeGroupsDeleteNodesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deleteNodes( + params?: Params$Resource$Nodegroups$Deletenodes, + options?: MethodOptions): AxiosPromise; + deleteNodes( + params: Params$Resource$Nodegroups$Deletenodes, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + deleteNodes( + params: Params$Resource$Nodegroups$Deletenodes, + callback: BodyResponseCallback): void; + deleteNodes(callback: BodyResponseCallback): void; + deleteNodes( + paramsOrCallback?: Params$Resource$Nodegroups$Deletenodes| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Nodegroups$Deletenodes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Deletenodes; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeGroups.get + * @desc Returns the specified NodeGroup. Get a list of available NodeGroups + * by making a list() request. Note: the "nodes" field should not be used. + * Use nodeGroups.listNodes instead. + * @alias compute.nodeGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the node group to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Nodegroups$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Nodegroups$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Nodegroups$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Nodegroups$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodegroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeGroups.insert + * @desc Creates a NodeGroup resource in the specified project using the + * data included in the request. + * @alias compute.nodeGroups.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer} params.initialNodeCount Initial count of nodes in the node group. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().NodeGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert(params?: Params$Resource$Nodegroups$Insert, options?: MethodOptions): + AxiosPromise; + insert( + params: Params$Resource$Nodegroups$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Nodegroups$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Nodegroups$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Nodegroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/nodeGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'initialNodeCount'], + pathParams: ['project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeGroups.list + * @desc Retrieves a list of node groups available to the specified project. + * Note: use nodeGroups.listNodes for more details about each group. + * @alias compute.nodeGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Nodegroups$List, options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Nodegroups$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Nodegroups$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Nodegroups$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodegroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/nodeGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeGroups.listNodes + * @desc Lists nodes in the node group. + * @alias compute.nodeGroups.listNodes + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string} params.nodeGroup Name of the NodeGroup resource whose nodes you want to list. + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listNodes( + params?: Params$Resource$Nodegroups$Listnodes, + options?: MethodOptions): AxiosPromise; + listNodes( + params: Params$Resource$Nodegroups$Listnodes, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + listNodes( + params: Params$Resource$Nodegroups$Listnodes, + callback: BodyResponseCallback): void; + listNodes(callback: BodyResponseCallback): void; + listNodes( + paramsOrCallback?: Params$Resource$Nodegroups$Listnodes| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Nodegroups$Listnodes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Listnodes; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeGroups.setNodeTemplate + * @desc Updates the node template of the node group. + * @alias compute.nodeGroups.setNodeTemplate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeGroup Name of the NodeGroup resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone for this request. + * @param {().NodeGroupsSetNodeTemplateRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setNodeTemplate( + params?: Params$Resource$Nodegroups$Setnodetemplate, + options?: MethodOptions): AxiosPromise; + setNodeTemplate( + params: Params$Resource$Nodegroups$Setnodetemplate, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setNodeTemplate( + params: Params$Resource$Nodegroups$Setnodetemplate, + callback: BodyResponseCallback): void; + setNodeTemplate(callback: BodyResponseCallback): void; + setNodeTemplate( + paramsOrCallback?: Params$Resource$Nodegroups$Setnodetemplate| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Nodegroups$Setnodetemplate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Setnodetemplate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Nodegroups$Addnodes { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the NodeGroup resource to delete. + */ + nodeGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NodeGroupsAddNodesRequest; + } + export interface Params$Resource$Nodegroups$Aggregatedlist { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Nodegroups$Delete { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the NodeGroup resource to delete. + */ + nodeGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Nodegroups$Deletenodes { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the NodeGroup resource to delete. + */ + nodeGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NodeGroupsDeleteNodesRequest; + } + export interface Params$Resource$Nodegroups$Get { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the node group to return. + */ + nodeGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Nodegroups$Insert { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Initial count of nodes in the node group. + */ + initialNodeCount?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NodeGroup; + } + export interface Params$Resource$Nodegroups$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Nodegroups$Listnodes { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Name of the NodeGroup resource whose nodes you want to list. + */ + nodeGroup?: string; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Nodegroups$Setnodetemplate { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the NodeGroup resource to delete. + */ + nodeGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NodeGroupsSetNodeTemplateRequest; + } + + + export class Resource$Nodetemplates { + root: Compute; + constructor(root: Compute) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * compute.nodeTemplates.aggregatedList + * @desc Retrieves an aggregated list of node templates. + * @alias compute.nodeTemplates.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Nodetemplates$Aggregatedlist, + options?: MethodOptions): + AxiosPromise; + aggregatedList( + params: Params$Resource$Nodetemplates$Aggregatedlist, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + aggregatedList( + params: Params$Resource$Nodetemplates$Aggregatedlist, + callback: BodyResponseCallback): + void; + aggregatedList(callback: + BodyResponseCallback): + void; + aggregatedList( + paramsOrCallback?: Params$Resource$Nodetemplates$Aggregatedlist| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Nodetemplates$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetemplates$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/compute/v1/projects/{project}/aggregated/nodeTemplates') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeTemplates.delete + * @desc Deletes the specified NodeTemplate resource. + * @alias compute.nodeTemplates.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeTemplate Name of the NodeTemplate resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Nodetemplates$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Nodetemplates$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Nodetemplates$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Nodetemplates$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Nodetemplates$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetemplates$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['project', 'region', 'nodeTemplate'], + pathParams: ['nodeTemplate', 'project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeTemplates.get + * @desc Returns the specified node template. Gets a list of available node + * templates by making a list() request. + * @alias compute.nodeTemplates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeTemplate Name of the node template to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Nodetemplates$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Nodetemplates$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Nodetemplates$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Nodetemplates$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Nodetemplates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetemplates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'region', 'nodeTemplate'], + pathParams: ['nodeTemplate', 'project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeTemplates.insert + * @desc Creates a NodeTemplate resource in the specified project using the + * data included in the request. + * @alias compute.nodeTemplates.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().NodeTemplate} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Nodetemplates$Insert, + options?: MethodOptions): AxiosPromise; + insert( + params: Params$Resource$Nodetemplates$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Nodetemplates$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Nodetemplates$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Nodetemplates$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetemplates$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/regions/{region}/nodeTemplates') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeTemplates.list + * @desc Retrieves a list of node templates available to the specified + * project. + * @alias compute.nodeTemplates.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Nodetemplates$List, options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Nodetemplates$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Nodetemplates$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Nodetemplates$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Nodetemplates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetemplates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/regions/{region}/nodeTemplates') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Nodetemplates$Aggregatedlist { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Nodetemplates$Delete { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the NodeTemplate resource to delete. + */ + nodeTemplate?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Nodetemplates$Get { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the node template to return. + */ + nodeTemplate?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Nodetemplates$Insert { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NodeTemplate; + } + export interface Params$Resource$Nodetemplates$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + } + + + export class Resource$Nodetypes { + root: Compute; + constructor(root: Compute) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * compute.nodeTypes.aggregatedList + * @desc Retrieves an aggregated list of node types. + * @alias compute.nodeTypes.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Nodetypes$Aggregatedlist, + options?: MethodOptions): AxiosPromise; + aggregatedList( + params: Params$Resource$Nodetypes$Aggregatedlist, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + aggregatedList( + params: Params$Resource$Nodetypes$Aggregatedlist, + callback: BodyResponseCallback): void; + aggregatedList( + callback: BodyResponseCallback): void; + aggregatedList( + paramsOrCallback?: Params$Resource$Nodetypes$Aggregatedlist| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Nodetypes$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetypes$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/compute/v1/projects/{project}/aggregated/nodeTypes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeTypes.get + * @desc Returns the specified node type. Gets a list of available node + * types by making a list() request. + * @alias compute.nodeTypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeType Name of the node type to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Nodetypes$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Nodetypes$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Nodetypes$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Nodetypes$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodetypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/nodeTypes/{nodeType}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'zone', 'nodeType'], + pathParams: ['nodeType', 'project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * compute.nodeTypes.list + * @desc Retrieves a list of node types available to the specified project. + * @alias compute.nodeTypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Nodetypes$List, options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Nodetypes$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Nodetypes$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Nodetypes$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodetypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/nodeTypes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Nodetypes$Aggregatedlist { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Name of the network to update. + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ - network?: string; + filter?: string; /** - * Project ID for this request. + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) */ - project?: string; + maxResults?: number; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. */ - requestId?: string; - + orderBy?: string; /** - * Request body metadata + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. */ - requestBody?: Schema$Network; + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; } - export interface Params$Resource$Networks$Removepeering { + export interface Params$Resource$Nodetypes$Get { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Name of the network resource to remove peering from. + * Name of the node type to return. */ - network?: string; + nodeType?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata + * The name of the zone for this request. */ - requestBody?: Schema$NetworksRemovePeeringRequest; + zone?: string; } - export interface Params$Resource$Networks$Switchtocustommode { + export interface Params$Resource$Nodetypes$List { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Name of the network to be updated. + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ - network?: string; + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; /** * Project ID for this request. */ project?: string; /** - * An optional request ID to identify requests. Specify a unique request ID - * so that if you must retry your request, the server will know to ignore - * the request if it has already been completed. For example, consider a - * situation where you make an initial request and the request times out. If - * you make the request again with the same request ID, the server can check - * if original operation with the same request ID was received, and if so, - * will ignore the second request. This prevents clients from accidentally - * creating duplicate commitments. The request ID must be a valid UUID with - * the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). + * The name of the zone for this request. */ - requestId?: string; + zone?: string; } @@ -38634,10 +41756,10 @@ export namespace compute_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter - * @param {integer=} params.maxResults - * @param {string=} params.order_by - * @param {string=} params.pageToken + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -38778,10 +41900,10 @@ export namespace compute_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter - * @param {integer=} params.maxResults - * @param {string=} params.order_by - * @param {string=} params.pageToken + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {().ProjectsListXpnHostsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -39223,6 +42345,79 @@ export namespace compute_v1 { } + /** + * compute.projects.setDefaultNetworkTier + * @desc Sets the default network tier of the project. The default network + * tier is used when an address/forwardingRule/instance is created without + * specifying the network tier field. + * @alias compute.projects.setDefaultNetworkTier + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().ProjectsSetDefaultNetworkTierRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setDefaultNetworkTier( + params?: Params$Resource$Projects$Setdefaultnetworktier, + options?: MethodOptions): AxiosPromise; + setDefaultNetworkTier( + params: Params$Resource$Projects$Setdefaultnetworktier, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setDefaultNetworkTier( + params: Params$Resource$Projects$Setdefaultnetworktier, + callback: BodyResponseCallback): void; + setDefaultNetworkTier(callback: BodyResponseCallback): + void; + setDefaultNetworkTier( + paramsOrCallback?: Params$Resource$Projects$Setdefaultnetworktier| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Setdefaultnetworktier; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Setdefaultnetworktier; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/compute/v1/projects/{project}/setDefaultNetworkTier') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * compute.projects.setUsageExportBucket * @desc Enables the usage export feature and sets the usage export bucket @@ -39486,19 +42681,46 @@ export namespace compute_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) */ maxResults?: number; /** - * + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. */ order_by?: string; /** - * + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -39513,19 +42735,46 @@ export namespace compute_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** - * + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) */ maxResults?: number; /** - * + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. */ order_by?: string; /** - * + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -39625,6 +42874,35 @@ export namespace compute_v1 { */ requestBody?: Schema$Metadata; } + export interface Params$Resource$Projects$Setdefaultnetworktier { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID + * so that if you must retry your request, the server will know to ignore + * the request if it has already been completed. For example, consider a + * situation where you make an initial request and the request times out. If + * you make the request again with the same request ID, the server can check + * if original operation with the same request ID was received, and if so, + * will ignore the second request. This prevents clients from accidentally + * creating duplicate commitments. The request ID must be a valid UUID with + * the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ProjectsSetDefaultNetworkTierRequest; + } export interface Params$Resource$Projects$Setusageexportbucket { /** * Auth client or API Key for the request @@ -44658,11 +47936,11 @@ export namespace compute_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). * @param {string} params.instanceGroupManager The name of the managed instance group. - * @param {integer=} params.maxResults - * @param {string=} params.order_by - * @param {string=} params.pageToken + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.order_by Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. * @param {string} params.project Project ID for this request. * @param {string} params.region Name of the region scoping this request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -45533,7 +48811,22 @@ export namespace compute_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; /** @@ -45541,15 +48834,27 @@ export namespace compute_v1 { */ instanceGroupManager?: string; /** - * + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) */ maxResults?: number; /** - * + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. */ order_by?: string; /** - * + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. */ pageToken?: string; /** @@ -52298,6 +55603,88 @@ export namespace compute_v1 { } + /** + * compute.subnetworks.listUsable + * @desc Retrieves an aggregated list of usable subnetworks. + * @alias compute.subnetworks.listUsable + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + listUsable( + params?: Params$Resource$Subnetworks$Listusable, + options?: MethodOptions): + AxiosPromise; + listUsable( + params: Params$Resource$Subnetworks$Listusable, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + listUsable( + params: Params$Resource$Subnetworks$Listusable, + callback: BodyResponseCallback): + void; + listUsable( + callback: BodyResponseCallback): + void; + listUsable( + paramsOrCallback?: Params$Resource$Subnetworks$Listusable| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Subnetworks$Listusable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subnetworks$Listusable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/compute/v1/projects/{project}/aggregated/subnetworks/listUsable') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + /** * compute.subnetworks.patch * @desc Patches the specified subnetwork with the data included in the @@ -52743,6 +56130,60 @@ export namespace compute_v1 { */ region?: string; } + export interface Params$Resource$Subnetworks$Listusable { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The + * expression must specify the field name, a comparison operator, and the + * value that you want to use for filtering. The value must be a string, a + * number, or a boolean. The comparison operator must be either =, !=, >, or + * <. For example, if you are filtering Compute Engine instances, you can + * exclude instances named example-instance by specifying name != + * example-instance. You can also filter nested fields. For example, you + * could specify scheduling.automaticRestart = false to include instances + * only if they are not scheduled for automatic restarts. You can use + * filtering on nested fields to filter based on resource labels. To filter + * on multiple expressions, provide each separate expression within + * parentheses. For example, (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake"). By default, each expression is an AND + * expression. However, you can include AND and OR expressions explicitly. + * For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + * Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the + * number of available results is larger than maxResults, Compute Engine + * returns a nextPageToken that can be used to get the next page of results + * in subsequent list requests. Acceptable values are 0 to 500, inclusive. + * (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned + * in alphanumerical order based on the resource name. You can also sort + * results in descending order based on the creation timestamp using + * orderBy="creationTimestamp desc". This sorts results based on the + * creationTimestamp field in reverse chronological order (newest result + * first). Use this to sort resources like operations so that the newest + * operation is returned first. Currently, only sorting by name or + * creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken + * returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } export interface Params$Resource$Subnetworks$Patch { /** * Auth client or API Key for the request diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index b290d2f7e00..46f95f90c29 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -540,7 +540,7 @@ export namespace container_v1 { /** * The parent (project, location, cluster id) where the node pool will be * created. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/*'. + * 'projects/x/locations/x/clusters/*'. */ parent?: string; /** @@ -3425,7 +3425,7 @@ export namespace container_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. + * @param {string} params.parent The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/x/locations/x/clusters/x'. * @param {().CreateNodePoolRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4064,8 +4064,7 @@ export namespace container_v1 { /** * The parent (project, location, cluster id) where the node pool will be - * created. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * created. Specified in the format 'projects/x/locations/x/clusters/x'. */ parent?: string; diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 907525e7a34..ce34b65a787 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -235,6 +235,10 @@ export namespace container_v1beta1 { * clusters are automatically deleted thirty days after creation. */ enableKubernetesAlpha?: boolean; + /** + * Enable the ability to use Cloud TPUs in this cluster. + */ + enableTpu?: boolean; /** * [Output only] The IP address of this cluster's master endpoint. The * endpoint can be accessed from the internet at @@ -422,6 +426,12 @@ export namespace container_v1beta1 { * connected. On output this shows the subnetwork ID instead of the name. */ subnetwork?: string; + /** + * [Output only] The IP address range of the Cloud TPUs in this cluster, in + * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + * notation (e.g. `1.2.3.4/29`). + */ + tpuIpv4CidrBlock?: string; /** * [Output only] The name of the Google Compute Engine * [zone](/compute/docs/zones#available) in which the cluster resides. This @@ -582,7 +592,7 @@ export namespace container_v1beta1 { /** * The parent (project, location, cluster id) where the node pool will be * created. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/*'. + * 'projects/x/locations/x/clusters/*'. */ parent?: string; /** @@ -739,6 +749,18 @@ export namespace container_v1beta1 { * subnetwork. */ subnetworkName?: string; + /** + * The IP address range of the Cloud TPUs in this cluster. If unspecified, a + * range will be automatically chosen with the default size. This field is + * only applicable when `use_ip_aliases` is true. If unspecified, the range + * will use the default size. Set to /netmask (e.g. `/14`) to have a range + * chosen with a specific netmask. Set to a + * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + * notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. + * `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range + * to use. + */ + tpuIpv4CidrBlock?: string; /** * Whether alias IPs will be used for pod IPs in the cluster. */ @@ -844,7 +866,7 @@ export namespace container_v1beta1 { */ export interface Schema$Location { /** - * Contains the name of the resource requested. Specific in the format + * Contains the name of the resource requested. Specified in the format * 'projects/x/locations/*'. */ name?: string; @@ -2250,7 +2272,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Contains the name of the resource requested. Specific in the format 'projects/x/locations'. + * @param {string} params.parent Contains the name of the resource requested. Specified in the format 'projects/x'. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2342,8 +2364,8 @@ export namespace container_v1beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Contains the name of the resource requested. Specific in the format - * 'projects/x/locations'. + * Contains the name of the resource requested. Specified in the format + * 'projects/x'. */ parent?: string; } @@ -3899,7 +3921,7 @@ export namespace container_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/x'. + * @param {string} params.parent The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/x/locations/x/clusters/x'. * @param {().CreateNodePoolRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4538,8 +4560,7 @@ export namespace container_v1beta1 { /** * The parent (project, location, cluster id) where the node pool will be - * created. Specified in the format - * 'projects/x/locations/x/clusters/x/nodePools/x'. + * created. Specified in the format 'projects/x/locations/x/clusters/x'. */ parent?: string; diff --git a/src/apis/content/v2.ts b/src/apis/content/v2.ts index 875cbd72b90..ed58a403f6d 100644 --- a/src/apis/content/v2.ts +++ b/src/apis/content/v2.ts @@ -233,8 +233,7 @@ export namespace content_v2 { */ account?: Schema$Account; /** - * The ID of the targeted account. Only defined if the method is get, delete - * or claimwebsite. + * The ID of the targeted account. Only defined if the method is not insert. */ accountId?: string; /** @@ -246,10 +245,17 @@ export namespace content_v2 { * applicable if the method is delete. */ force?: boolean; + /** + * Details about the link request. + */ + linkRequest?: Schema$AccountsCustomBatchRequestEntryLinkRequest; /** * The ID of the managing account. */ merchantId?: string; + /** + * The method of the batch entry. + */ method?: string; /** * Only applicable if the method is claimwebsite. Indicates whether or not @@ -257,6 +263,20 @@ export namespace content_v2 { */ overwrite?: boolean; } + export interface Schema$AccountsCustomBatchRequestEntryLinkRequest { + /** + * Action to perform for this link. + */ + action?: string; + /** + * The ID of the linked account. + */ + linkedAccountId?: string; + /** + * Type of the link between the two accounts. + */ + linkType?: string; + } export interface Schema$AccountsCustomBatchResponse { /** * The result of the execution of the batch requests. @@ -274,7 +294,7 @@ export namespace content_v2 { export interface Schema$AccountsCustomBatchResponseEntry { /** * The retrieved, created, or updated account. Not defined if the method was - * delete or claimwebsite. + * delete, claimwebsite or link. */ account?: Schema$Account; /** @@ -290,6 +310,31 @@ export namespace content_v2 { * "content#accountsCustomBatchResponseEntry". */ kind?: string; + /** + * The status of the updated link. Only defined if the method is link. + */ + linkStatus?: string; + } + export interface Schema$AccountsLinkRequest { + /** + * Action to perform for this link. + */ + action?: string; + /** + * The ID of the linked account. + */ + linkedAccountId?: string; + /** + * Type of the link between the two accounts. + */ + linkType?: string; + } + export interface Schema$AccountsLinkResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "content#accountsLinkResponse". + */ + kind?: string; } export interface Schema$AccountsListResponse { /** @@ -652,11 +697,11 @@ export namespace content_v2 { } export interface Schema$Amount { /** - * Value before taxes. + * [required] Value before taxes. */ pretax?: Schema$Price; /** - * Tax value. + * [required] Tax value. */ tax?: Schema$Price; } @@ -1528,27 +1573,28 @@ export namespace content_v2 { */ additionalChargeSummaries?: Schema$InvoiceSummaryAdditionalChargeSummary[]; /** - * Customer balance on this invoice. A positive amount means the customer is - * paying, a negative one means the customer is receiving money. Note that - * it must always be true that merchant_balance + customer_balance + - * google_balance = 0. + * [required] Customer balance on this invoice. A positive amount means the + * customer is paying, a negative one means the customer is receiving money. + * Note: the sum of merchant_balance, customer_balance and google_balance + * must always be zero. */ customerBalance?: Schema$Amount; /** - * Google balance on this invoice. A positive amount means Google is paying, - * a negative one means Google is receiving money. Note that it must always - * be true that merchant_balance + customer_balance + google_balance = 0. + * [required] Google balance on this invoice. A positive amount means Google + * is paying, a negative one means Google is receiving money. Note: the sum + * of merchant_balance, customer_balance and google_balance must always be + * zero. */ googleBalance?: Schema$Amount; /** - * Merchant balance on this invoice. A positive amount means the merchant is - * paying, a negative one means the merchant is receiving money. Note that - * it must always be true that merchant_balance + customer_balance + - * google_balance = 0. + * [required] Merchant balance on this invoice. A positive amount means the + * merchant is paying, a negative one means the merchant is receiving money. + * Note: the sum of merchant_balance, customer_balance and google_balance + * must always be zero. */ merchantBalance?: Schema$Amount; /** - * Total price for the product. + * [required] Total price for the product. */ productTotal?: Schema$Amount; /** @@ -1558,11 +1604,11 @@ export namespace content_v2 { } export interface Schema$InvoiceSummaryAdditionalChargeSummary { /** - * Total additional charge for this type. + * [required] Total additional charge for this type. */ totalAmount?: Schema$Amount; /** - * Type of the additional charge. + * [required] Type of the additional charge. */ type?: string; } @@ -2034,23 +2080,24 @@ export namespace content_v2 { } export interface Schema$OrderinvoicesCreateChargeInvoiceRequest { /** - * The ID of the invoice. + * [required] The ID of the invoice. */ invoiceId?: string; /** - * Invoice summary. + * [required] Invoice summary. */ invoiceSummary?: Schema$InvoiceSummary; /** - * Invoice details per line item. + * [required] Invoice details per line item. */ lineItemInvoices?: Schema$ShipmentInvoiceLineItemInvoice[]; /** - * The ID of the operation, unique across all operations for a given order. + * [required] The ID of the operation, unique across all operations for a + * given order. */ operationId?: string; /** - * ID of the shipment group. + * [required] ID of the shipment group. */ shipmentGroupId?: string; } @@ -2067,22 +2114,23 @@ export namespace content_v2 { } export interface Schema$OrderinvoicesCreateRefundInvoiceRequest { /** - * The ID of the invoice. + * [required] The ID of the invoice. */ invoiceId?: string; /** - * The ID of the operation, unique across all operations for a given order. + * [required] The ID of the operation, unique across all operations for a + * given order. */ operationId?: string; /** - * Option to create a refund-only invoice. Exactly one of refund_option and - * return_option must be provided. + * Option to create a refund-only invoice. Exactly one of refundOnlyOption + * or returnOption must be provided. */ refundOnlyOption?: Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption; /** * Option to create an invoice for a refund and mark all items within the - * invoice as returned. Exactly one of refund_option and return_option must + * invoice as returned. Exactly one of refundOnlyOption or returnOption must * be provided. */ returnOption?: @@ -2109,7 +2157,7 @@ export namespace content_v2 { */ description?: string; /** - * Reason for the refund. + * [required] Reason for the refund. */ reason?: string; } @@ -2119,7 +2167,7 @@ export namespace content_v2 { */ description?: string; /** - * Reason for the return. + * [required] Reason for the return. */ reason?: string; } @@ -3013,6 +3061,11 @@ export namespace content_v2 { * acceptable values. */ carrier?: string; + /** + * Date on which the shipment has been delivered, in ISO 8601 format. + * Optional and can be provided only if status is delivered. + */ + deliveryDate?: string; /** * The ID of the shipment. */ @@ -3101,7 +3154,7 @@ export namespace content_v2 { creationDate?: string; /** * Date on which the shipment has been delivered, in ISO 8601 format. - * Present only if status is delievered + * Present only if status is delivered */ deliveryDate?: string; /** @@ -3501,6 +3554,11 @@ export namespace content_v2 { * acceptable values. */ carrier?: string; + /** + * Date on which the shipment has been delivered, in ISO 8601 format. + * Optional and can be provided only if status is delivered. + */ + deliveryDate?: string; /** * The ID of the operation. Unique across all operations for a given order. */ @@ -4013,6 +4071,10 @@ export namespace content_v2 { * The two-letter ISO 639-1 language code for the item. */ contentLanguage?: string; + /** + * Cost of goods sold. Used for gross profit reporting. + */ + costOfGoodsSold?: Schema$Price; /** * A list of custom (merchant-provided) attributes. It can also be used for * submitting any attribute of the feed specification in its generic form @@ -4144,10 +4206,18 @@ export namespace content_v2 { * The material of which the item is made. */ material?: string; + /** + * The energy efficiency class as defined in EU directive 2010/30/EU. + */ + maxEnergyEfficiencyClass?: string; /** * Maximal product handling time (in business days). */ maxHandlingTime?: string; + /** + * The energy efficiency class as defined in EU directive 2010/30/EU. + */ + minEnergyEfficiencyClass?: string; /** * Minimal product handling time (in business days). */ @@ -4728,12 +4798,12 @@ export namespace content_v2 { } export interface Schema$Promotion { /** - * Amount of the promotion. The values here are the promotion applied to the - * unit price pretax and to the total of the tax amounts. + * [required] Amount of the promotion. The values here are the promotion + * applied to the unit price pretax and to the total of the tax amounts. */ promotionAmount?: Schema$Amount; /** - * ID of the promotion. + * [required] ID of the promotion. */ promotionId?: string; } @@ -4823,15 +4893,15 @@ export namespace content_v2 { } export interface Schema$ShipmentInvoice { /** - * Invoice summary. + * [required] Invoice summary. */ invoiceSummary?: Schema$InvoiceSummary; /** - * Invoice details per line item. + * [required] Invoice details per line item. */ lineItemInvoices?: Schema$ShipmentInvoiceLineItemInvoice[]; /** - * ID of the shipment group. + * [required] ID of the shipment group. */ shipmentGroupId?: string; } @@ -4846,11 +4916,11 @@ export namespace content_v2 { */ productId?: string; /** - * Unit IDs to define specific units within the line item. + * [required] Unit IDs to define specific units within the line item. */ shipmentUnitIds?: string[]; /** - * Invoice details for a single unit. + * [required] Invoice details for a single unit. */ unitInvoice?: Schema$UnitInvoice; } @@ -5177,7 +5247,7 @@ export namespace content_v2 { */ promotions?: Schema$Promotion[]; /** - * Price of the unit, before applying taxes. + * [required] Price of the unit, before applying taxes. */ unitPricePretax?: Schema$Price; /** @@ -5187,7 +5257,7 @@ export namespace content_v2 { } export interface Schema$UnitInvoiceAdditionalCharge { /** - * Amount of the additional charge. + * [required] Amount of the additional charge. */ additionalChargeAmount?: Schema$Amount; /** @@ -5195,21 +5265,22 @@ export namespace content_v2 { */ additionalChargePromotions?: Schema$Promotion[]; /** - * Type of the additional charge. + * [required] Type of the additional charge. */ type?: string; } export interface Schema$UnitInvoiceTaxLine { /** - * Tax amount for the tax type. + * [required] Tax amount for the tax type. */ taxAmount?: Schema$Price; /** - * Optional name of the tax type. + * Optional name of the tax type. This should only be provided if taxType is + * otherFeeTax. */ taxName?: string; /** - * Type of the tax. + * [required] Type of the tax. */ taxType?: string; } @@ -5684,6 +5755,76 @@ export namespace content_v2 { } + /** + * content.accounts.link + * @desc Performs an action on a link between a Merchant Center account and + * another account. + * @alias content.accounts.link + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.accountId The ID of the account that should be linked. + * @param {string} params.merchantId The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. + * @param {().AccountsLinkRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + link(params?: Params$Resource$Accounts$Link, options?: MethodOptions): + AxiosPromise; + link( + params: Params$Resource$Accounts$Link, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + link( + params: Params$Resource$Accounts$Link, + callback: BodyResponseCallback): void; + link(callback: BodyResponseCallback): void; + link( + paramsOrCallback?: Params$Resource$Accounts$Link| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Link; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Link; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/content/v2/{merchantId}/accounts/{accountId}/link') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['merchantId', 'accountId'], + pathParams: ['accountId', 'merchantId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * content.accounts.list * @desc Lists the sub-accounts in your Merchant Center account. @@ -5993,6 +6134,28 @@ export namespace content_v2 { */ requestBody?: Schema$Account; } + export interface Params$Resource$Accounts$Link { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the account that should be linked. + */ + accountId?: string; + /** + * The ID of the managing account. If this parameter is not the same as + * accountId, then this account must be a multi-client account and accountId + * must be the ID of a sub-account of this account. + */ + merchantId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountsLinkRequest; + } export interface Params$Resource$Accounts$List { /** * Auth client or API Key for the request diff --git a/src/apis/content/v2sandbox.ts b/src/apis/content/v2sandbox.ts index e9f1614a46e..e9556c6f4d4 100644 --- a/src/apis/content/v2sandbox.ts +++ b/src/apis/content/v2sandbox.ts @@ -72,11 +72,11 @@ export namespace content_v2sandbox { export interface Schema$Amount { /** - * Value before taxes. + * [required] Value before taxes. */ pretax?: Schema$Price; /** - * Tax value. + * [required] Tax value. */ tax?: Schema$Price; } @@ -120,27 +120,28 @@ export namespace content_v2sandbox { */ additionalChargeSummaries?: Schema$InvoiceSummaryAdditionalChargeSummary[]; /** - * Customer balance on this invoice. A positive amount means the customer is - * paying, a negative one means the customer is receiving money. Note that - * it must always be true that merchant_balance + customer_balance + - * google_balance = 0. + * [required] Customer balance on this invoice. A positive amount means the + * customer is paying, a negative one means the customer is receiving money. + * Note: the sum of merchant_balance, customer_balance and google_balance + * must always be zero. */ customerBalance?: Schema$Amount; /** - * Google balance on this invoice. A positive amount means Google is paying, - * a negative one means Google is receiving money. Note that it must always - * be true that merchant_balance + customer_balance + google_balance = 0. + * [required] Google balance on this invoice. A positive amount means Google + * is paying, a negative one means Google is receiving money. Note: the sum + * of merchant_balance, customer_balance and google_balance must always be + * zero. */ googleBalance?: Schema$Amount; /** - * Merchant balance on this invoice. A positive amount means the merchant is - * paying, a negative one means the merchant is receiving money. Note that - * it must always be true that merchant_balance + customer_balance + - * google_balance = 0. + * [required] Merchant balance on this invoice. A positive amount means the + * merchant is paying, a negative one means the merchant is receiving money. + * Note: the sum of merchant_balance, customer_balance and google_balance + * must always be zero. */ merchantBalance?: Schema$Amount; /** - * Total price for the product. + * [required] Total price for the product. */ productTotal?: Schema$Amount; /** @@ -150,11 +151,11 @@ export namespace content_v2sandbox { } export interface Schema$InvoiceSummaryAdditionalChargeSummary { /** - * Total additional charge for this type. + * [required] Total additional charge for this type. */ totalAmount?: Schema$Amount; /** - * Type of the additional charge. + * [required] Type of the additional charge. */ type?: string; } @@ -353,23 +354,24 @@ export namespace content_v2sandbox { } export interface Schema$OrderinvoicesCreateChargeInvoiceRequest { /** - * The ID of the invoice. + * [required] The ID of the invoice. */ invoiceId?: string; /** - * Invoice summary. + * [required] Invoice summary. */ invoiceSummary?: Schema$InvoiceSummary; /** - * Invoice details per line item. + * [required] Invoice details per line item. */ lineItemInvoices?: Schema$ShipmentInvoiceLineItemInvoice[]; /** - * The ID of the operation, unique across all operations for a given order. + * [required] The ID of the operation, unique across all operations for a + * given order. */ operationId?: string; /** - * ID of the shipment group. + * [required] ID of the shipment group. */ shipmentGroupId?: string; } @@ -386,22 +388,23 @@ export namespace content_v2sandbox { } export interface Schema$OrderinvoicesCreateRefundInvoiceRequest { /** - * The ID of the invoice. + * [required] The ID of the invoice. */ invoiceId?: string; /** - * The ID of the operation, unique across all operations for a given order. + * [required] The ID of the operation, unique across all operations for a + * given order. */ operationId?: string; /** - * Option to create a refund-only invoice. Exactly one of refund_option and - * return_option must be provided. + * Option to create a refund-only invoice. Exactly one of refundOnlyOption + * or returnOption must be provided. */ refundOnlyOption?: Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption; /** * Option to create an invoice for a refund and mark all items within the - * invoice as returned. Exactly one of refund_option and return_option must + * invoice as returned. Exactly one of refundOnlyOption or returnOption must * be provided. */ returnOption?: @@ -428,7 +431,7 @@ export namespace content_v2sandbox { */ description?: string; /** - * Reason for the refund. + * [required] Reason for the refund. */ reason?: string; } @@ -438,7 +441,7 @@ export namespace content_v2sandbox { */ description?: string; /** - * Reason for the return. + * [required] Reason for the return. */ reason?: string; } @@ -1332,6 +1335,11 @@ export namespace content_v2sandbox { * acceptable values. */ carrier?: string; + /** + * Date on which the shipment has been delivered, in ISO 8601 format. + * Optional and can be provided only if status is delivered. + */ + deliveryDate?: string; /** * The ID of the shipment. */ @@ -1420,7 +1428,7 @@ export namespace content_v2sandbox { creationDate?: string; /** * Date on which the shipment has been delivered, in ISO 8601 format. - * Present only if status is delievered + * Present only if status is delivered */ deliveryDate?: string; /** @@ -1820,6 +1828,11 @@ export namespace content_v2sandbox { * acceptable values. */ carrier?: string; + /** + * Date on which the shipment has been delivered, in ISO 8601 format. + * Optional and can be provided only if status is delivered. + */ + deliveryDate?: string; /** * The ID of the operation. Unique across all operations for a given order. */ @@ -1860,26 +1873,26 @@ export namespace content_v2sandbox { } export interface Schema$Promotion { /** - * Amount of the promotion. The values here are the promotion applied to the - * unit price pretax and to the total of the tax amounts. + * [required] Amount of the promotion. The values here are the promotion + * applied to the unit price pretax and to the total of the tax amounts. */ promotionAmount?: Schema$Amount; /** - * ID of the promotion. + * [required] ID of the promotion. */ promotionId?: string; } export interface Schema$ShipmentInvoice { /** - * Invoice summary. + * [required] Invoice summary. */ invoiceSummary?: Schema$InvoiceSummary; /** - * Invoice details per line item. + * [required] Invoice details per line item. */ lineItemInvoices?: Schema$ShipmentInvoiceLineItemInvoice[]; /** - * ID of the shipment group. + * [required] ID of the shipment group. */ shipmentGroupId?: string; } @@ -1894,11 +1907,11 @@ export namespace content_v2sandbox { */ productId?: string; /** - * Unit IDs to define specific units within the line item. + * [required] Unit IDs to define specific units within the line item. */ shipmentUnitIds?: string[]; /** - * Invoice details for a single unit. + * [required] Invoice details for a single unit. */ unitInvoice?: Schema$UnitInvoice; } @@ -2090,7 +2103,7 @@ export namespace content_v2sandbox { */ promotions?: Schema$Promotion[]; /** - * Price of the unit, before applying taxes. + * [required] Price of the unit, before applying taxes. */ unitPricePretax?: Schema$Price; /** @@ -2100,7 +2113,7 @@ export namespace content_v2sandbox { } export interface Schema$UnitInvoiceAdditionalCharge { /** - * Amount of the additional charge. + * [required] Amount of the additional charge. */ additionalChargeAmount?: Schema$Amount; /** @@ -2108,21 +2121,22 @@ export namespace content_v2sandbox { */ additionalChargePromotions?: Schema$Promotion[]; /** - * Type of the additional charge. + * [required] Type of the additional charge. */ type?: string; } export interface Schema$UnitInvoiceTaxLine { /** - * Tax amount for the tax type. + * [required] Tax amount for the tax type. */ taxAmount?: Schema$Price; /** - * Optional name of the tax type. + * Optional name of the tax type. This should only be provided if taxType is + * otherFeeTax. */ taxName?: string; /** - * Type of the tax. + * [required] Type of the tax. */ taxType?: string; } diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index d28a62aa8f0..765e588b6a9 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -190,6 +190,44 @@ export namespace dataflow_v1b3 { */ maxNumWorkers?: number; } + /** + * Metadata for a BigQuery connector used by the job. + */ + export interface Schema$BigQueryIODetails { + /** + * Dataset accessed in the connection. + */ + dataset?: string; + /** + * Project accessed in the connection. + */ + projectId?: string; + /** + * Query used to access data in the connection. + */ + query?: string; + /** + * Table accessed in the connection. + */ + table?: string; + } + /** + * Metadata for a BigTable connector used by the job. + */ + export interface Schema$BigTableIODetails { + /** + * InstanceId accessed in the connection. + */ + instanceId?: string; + /** + * ProjectId accessed in the connection. + */ + projectId?: string; + /** + * TableId accessed in the connection. + */ + tableId?: string; + } /** * Description of an interstitial value between transforms in an execution * stage. @@ -500,6 +538,19 @@ export namespace dataflow_v1b3 { */ vmInstance?: string; } + /** + * Metadata for a Datastore connector used by the job. + */ + export interface Schema$DatastoreIODetails { + /** + * Namespace used in the connection. + */ + namespace?: string; + /** + * ProjectId accessed in the connection. + */ + projectId?: string; + } /** * Specification of one of the bundles produced as a result of splitting a * Source (e.g. when executing a SourceSplitRequest, or when splitting an @@ -778,6 +829,15 @@ export namespace dataflow_v1b3 { */ name?: string; } + /** + * Metadata for a File connector used by the job. + */ + export interface Schema$FileIODetails { + /** + * File Pattern used to access files by the connector. + */ + filePattern?: string; + } /** * An instruction that copies its inputs (zero or more) to its (single) * output. @@ -1004,6 +1064,12 @@ export namespace dataflow_v1b3 { * job. */ id?: string; + /** + * This field is populated by the Dataflow service to support filtering jobs + * by the metadata values provided here. Populated for ListJobs and all + * GetJob views SUMMARY and higher. + */ + jobMetadata?: Schema$JobMetadata; /** * User-defined labels for this job. The labels map can contain no more * than 64 entries. Entries of the labels map are UTF8 strings that comply @@ -1127,6 +1193,40 @@ export namespace dataflow_v1b3 { */ time?: string; } + /** + * Metadata available primarily for filtering jobs. Will be included in the + * ListJob response and Job SUMMARY view+. + */ + export interface Schema$JobMetadata { + /** + * Identification of a BigQuery source used in the Dataflow job. + */ + bigqueryDetails?: Schema$BigQueryIODetails[]; + /** + * Identification of a BigTable source used in the Dataflow job. + */ + bigTableDetails?: Schema$BigTableIODetails[]; + /** + * Identification of a Datastore source used in the Dataflow job. + */ + datastoreDetails?: Schema$DatastoreIODetails[]; + /** + * Identification of a File source used in the Dataflow job. + */ + fileDetails?: Schema$FileIODetails[]; + /** + * Identification of a PubSub source used in the Dataflow job. + */ + pubsubDetails?: Schema$PubSubIODetails[]; + /** + * The SDK version used to run the job. + */ + sdkVersion?: Schema$SdkVersion; + /** + * Identification of a Spanner source used in the Dataflow job. + */ + spannerDetails?: Schema$SpannerIODetails[]; + } /** * JobMetrics contains a collection of metrics descibing the detailed progress * of a Dataflow job. Metrics correspond to user-defined and system-defined @@ -1676,6 +1776,19 @@ export namespace dataflow_v1b3 { */ shufflePosition?: string; } + /** + * Metadata for a PubSub connector used by the job. + */ + export interface Schema$PubSubIODetails { + /** + * Subscription used in the connection. + */ + subscription?: string; + /** + * Topic accessed in the connection. + */ + topic?: string; + } /** * Identifies a pubsub location to use for transferring data into or out of a * streaming Dataflow job. @@ -1844,6 +1957,23 @@ export namespace dataflow_v1b3 { */ zone?: string; } + /** + * The version of the SDK used to run the jobl + */ + export interface Schema$SdkVersion { + /** + * The support status for this SDK version. + */ + sdkSupportStatus?: string; + /** + * The version of the SDK used to run the job. + */ + version?: string; + /** + * A readable string describing the version of the sdk. + */ + versionDisplayName?: string; + } /** * Request to send encoded debug information. */ @@ -2210,6 +2340,23 @@ export namespace dataflow_v1b3 { */ source?: Schema$Source; } + /** + * Metadata for a Spanner connector used by the job. + */ + export interface Schema$SpannerIODetails { + /** + * DatabaseId accessed in the connection. + */ + databaseId?: string; + /** + * InstanceId accessed in the connection. + */ + instanceId?: string; + /** + * ProjectId accessed in the connection. + */ + projectId?: string; + } /** * A representation of an int64, n, that is immune to precision loss when * encoded in JSON. diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index c90f4761bf1..233cde27e9f 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -530,8 +530,8 @@ export namespace dataproc_v1 { */ diskConfig?: Schema$DiskConfig; /** - * Output only. The Compute Engine image resource used for cluster - * instances. Inferred from SoftwareConfig.image_version. + * Optional. The Compute Engine image resource used for cluster instances. + * It can be specified or may be inferred from SoftwareConfig.image_version. */ imageUri?: string; /** diff --git a/src/apis/dataproc/v1beta2.ts b/src/apis/dataproc/v1beta2.ts index 37968172f92..569005063b5 100644 --- a/src/apis/dataproc/v1beta2.ts +++ b/src/apis/dataproc/v1beta2.ts @@ -109,7 +109,7 @@ export namespace dataproc_v1beta2 { members?: string[]; /** * Role that is assigned to members. For example, roles/viewer, - * roles/editor, or roles/owner. Required + * roles/editor, or roles/owner. */ role?: string; } @@ -594,8 +594,8 @@ export namespace dataproc_v1beta2 { */ diskConfig?: Schema$DiskConfig; /** - * Output only. The Compute Engine image resource used for cluster - * instances. Inferred from SoftwareConfig.image_version. + * Optional. The Compute Engine image resource used for cluster instances. + * It can be specified or may be inferred from SoftwareConfig.image_version. */ imageUri?: string; /** @@ -639,12 +639,7 @@ export namespace dataproc_v1beta2 { */ export interface Schema$InstantiateWorkflowTemplateRequest { /** - * Optional. A tag that prevents multiple concurrent workflow instances with - * the same tag from running. This mitigates risk of concurrent instances - * started due to retries.It is recommended to always set this value to a - * UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The - * tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), - * and hyphens (-). The maximum length is 40 characters. + * Deprecated. Please use request_id field instead. */ instanceId?: string; /** @@ -652,6 +647,15 @@ export namespace dataproc_v1beta2 { * those parameters. */ parameters?: any; + /** + * Optional. A tag that prevents multiple concurrent workflow instances with + * the same tag from running. This mitigates risk of concurrent instances + * started due to retries.It is recommended to always set this value to a + * UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The + * tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), + * and hyphens (-). The maximum length is 40 characters. + */ + requestId?: string; /** * Optional. The version of workflow template to instantiate. If specified, * the workflow will be instantiated only if the current version of the diff --git a/src/apis/datastore/v1.ts b/src/apis/datastore/v1.ts index 4975306db5d..f40ab3b025b 100644 --- a/src/apis/datastore/v1.ts +++ b/src/apis/datastore/v1.ts @@ -548,6 +548,81 @@ export namespace datastore_v1 { */ labels?: any; } + /** + * A minimal index definition. Next tag: 8 + */ + export interface Schema$GoogleDatastoreAdminV1Index { + /** + * The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. + * Required. + */ + ancestor?: string; + /** + * The resource ID of the index. Output only. + */ + indexId?: string; + /** + * The entity kind to which this index applies. Required. + */ + kind?: string; + /** + * Project ID. Output only. + */ + projectId?: string; + /** + * An ordered sequence of property names and their index attributes. + * Required. + */ + properties?: Schema$GoogleDatastoreAdminV1IndexedProperty[]; + /** + * The state of the index. Output only. + */ + state?: string; + } + /** + * Next tag: 3 + */ + export interface Schema$GoogleDatastoreAdminV1IndexedProperty { + /** + * The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. + * Required. + */ + direction?: string; + /** + * The property name to index. Required. + */ + name?: string; + } + /** + * Metadata for Index operations. + */ + export interface Schema$GoogleDatastoreAdminV1IndexOperationMetadata { + /** + * Metadata common to all Datastore Admin operations. + */ + common?: Schema$GoogleDatastoreAdminV1CommonMetadata; + /** + * The index resource ID that this operation is acting on. + */ + indexId?: string; + /** + * An estimate of the number of entities processed. + */ + progressEntities?: Schema$GoogleDatastoreAdminV1Progress; + } + /** + * The response for google.datastore.admin.v1.DatastoreAdmin.ListIndexes. + */ + export interface Schema$GoogleDatastoreAdminV1ListIndexesResponse { + /** + * The indexes. + */ + indexes?: Schema$GoogleDatastoreAdminV1Index[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string; + } /** * Measures the progress of a particular metric. */ @@ -1226,10 +1301,12 @@ export namespace datastore_v1 { export class Resource$Projects { root: Datastore; + indexes: Resource$Projects$Indexes; operations: Resource$Projects$Operations; constructor(root: Datastore) { this.root = root; this.getRoot.bind(this); + this.indexes = new Resource$Projects$Indexes(root); this.operations = new Resource$Projects$Operations(root); } @@ -1979,6 +2056,208 @@ import(paramsOrCallback?: Params$Resource$Projects$Import|BodyResponseCallback; + get(params: Params$Resource$Projects$Indexes$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + get(params: Params$Resource$Projects$Indexes$Get, + callback: BodyResponseCallback): + void; + get(callback: BodyResponseCallback): + void; + get(paramsOrCallback?: Params$Resource$Projects$Indexes$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Indexes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Indexes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datastore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/projects/{projectId}/indexes/{indexId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['projectId', 'indexId'], + pathParams: ['indexId', 'projectId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * datastore.projects.indexes.list + * @desc Lists the indexes that match the specified filters. Datastore uses + * an eventually consistent query to fetch the list of indexes and may + * occasionally return stale results. + * @alias datastore.projects.indexes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter + * @param {integer=} params.pageSize The maximum number of items to return. If zero, then all results will be returned. + * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. + * @param {string} params.projectId Project ID against which to make the request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Indexes$List, + options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Projects$Indexes$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GoogleDatastoreAdminV1ListIndexesResponse>): void; + list( + params: Params$Resource$Projects$Indexes$List, + callback: BodyResponseCallback< + Schema$GoogleDatastoreAdminV1ListIndexesResponse>): void; + list(callback: BodyResponseCallback< + Schema$GoogleDatastoreAdminV1ListIndexesResponse>): void; + list( + paramsOrCallback?: Params$Resource$Projects$Indexes$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleDatastoreAdminV1ListIndexesResponse>): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Indexes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Indexes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datastore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/projects/{projectId}/indexes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['projectId'], + pathParams: ['projectId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleDatastoreAdminV1ListIndexesResponse>(parameters); + } + } + } + + export interface Params$Resource$Projects$Indexes$Get { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource ID of the index to get. + */ + indexId?: string; + /** + * Project ID against which to make the request. + */ + projectId?: string; + } + export interface Params$Resource$Projects$Indexes$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * + */ + filter?: string; + /** + * The maximum number of items to return. If zero, then all results will be + * returned. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + */ + pageToken?: string; + /** + * Project ID against which to make the request. + */ + projectId?: string; + } + + export class Resource$Projects$Operations { root: Datastore; constructor(root: Datastore) { diff --git a/src/apis/datastore/v1beta1.ts b/src/apis/datastore/v1beta1.ts index 376990c19e2..0d4a2edf073 100644 --- a/src/apis/datastore/v1beta1.ts +++ b/src/apis/datastore/v1beta1.ts @@ -385,6 +385,23 @@ export namespace datastore_v1beta1 { */ progressEntities?: Schema$GoogleDatastoreAdminV1Progress; } + /** + * Metadata for Index operations. + */ + export interface Schema$GoogleDatastoreAdminV1IndexOperationMetadata { + /** + * Metadata common to all Datastore Admin operations. + */ + common?: Schema$GoogleDatastoreAdminV1CommonMetadata; + /** + * The index resource ID that this operation is acting on. + */ + indexId?: string; + /** + * An estimate of the number of entities processed. + */ + progressEntities?: Schema$GoogleDatastoreAdminV1Progress; + } /** * Measures the progress of a particular metric. */ diff --git a/src/apis/datastore/v1beta3.ts b/src/apis/datastore/v1beta3.ts index aeeec339f9d..7d88bc0e9be 100644 --- a/src/apis/datastore/v1beta3.ts +++ b/src/apis/datastore/v1beta3.ts @@ -480,6 +480,23 @@ export namespace datastore_v1beta3 { */ progressEntities?: Schema$GoogleDatastoreAdminV1Progress; } + /** + * Metadata for Index operations. + */ + export interface Schema$GoogleDatastoreAdminV1IndexOperationMetadata { + /** + * Metadata common to all Datastore Admin operations. + */ + common?: Schema$GoogleDatastoreAdminV1CommonMetadata; + /** + * The index resource ID that this operation is acting on. + */ + indexId?: string; + /** + * An estimate of the number of entities processed. + */ + progressEntities?: Schema$GoogleDatastoreAdminV1Progress; + } /** * Measures the progress of a particular metric. */ diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 55369e5d6ab..adab722d1ca 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -313,11 +313,10 @@ export namespace dialogflow_v2 { * `projects/<Project ID>/agent/sessions/<Session * ID>/contexts/<Context ID>`, or `projects/<Project * ID>/agent/environments/<Environment ID>/users/<User - * ID>/sessions/<Session ID>/contexts/<Context ID>`. Note: - * Environments and users are under construction and will be available soon. - * The Context ID is always converted to lowercase. If <Environment - * ID> is not specified, we assume default 'draft' environment. - * If <User ID> is not specified, we assume default '-' user. + * ID>/sessions/<Session ID>/contexts/<Context ID>`. The + * `Context ID` is always converted to lowercase. If `Environment ID` is not + * specified, we assume default 'draft' environment. If `User ID` is + * not specified, we assume default '-' user. */ name?: string; /** @@ -402,14 +401,15 @@ export namespace dialogflow_v2 { export interface Schema$GoogleCloudDialogflowV2beta1ExportAgentResponse { /** * The exported agent. Example for how to export an agent to a zip file via - * a command line: curl \ - * 'https://dialogflow.googleapis.com/v2beta1/projects/<project_name>/agent:export'\ + * a command line: <pre>curl \ + * 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:export'\ * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * print-access-token) \ -H 'Accept: application/json' \ -H - * 'Content-Type: application/json' \ --compressed \ --data-binary - * '{}' \ | grep agentContent | sed -e - * 's/.*"agentContent": "\([^"]*\)".x/\1/' - * \ | base64 --decode > <agent zip file> + * application-default print-access-token) \ -H 'Accept: + * application/json' \ -H 'Content-Type: application/json' \ + * --compressed \ --data-binary '{}' \ | grep agentContent | sed + * -e 's/.*"agentContent": + * "\([^"]*\)".x/\1/' \ | base64 --decode > + * &lt;agent zip file&gt;</pre> */ agentContent?: string; /** @@ -421,11 +421,12 @@ export namespace dialogflow_v2 { /** * Represents an intent. Intents convert a number of user expressions or * patterns into an action. An action is an extraction of a user command or - * sentence semantics. Next available field number: 22. + * sentence semantics. */ export interface Schema$GoogleCloudDialogflowV2beta1Intent { /** - * Optional. The name of the action associated with the intent. + * Optional. The name of the action associated with the intent. Note: The + * action name must not contain whitespaces. */ action?: string; /** @@ -985,7 +986,15 @@ export namespace dialogflow_v2 { export interface Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest { /** * Optional. This field is set to the value of `QueryParameters.payload` - * field passed in the request. + * field passed in the request. This field is used for the telephony + * gateway. It should have a structure similar to this JSON message: + * <pre>{ "telephony": { "caller_id": + * "+18558363987" }</pre> Note: The caller ID field + * (`caller_id`) will be in [E.164 + * format](https://en.wikipedia.org/wiki/E.164) and is not supported for + * standard tier agents. When the telephony gateway is used with a standard + * tier agent the `caller_id` field above will have a value of + * `REDACTED_IN_STANDARD_TIER_AGENT`. */ payload?: any; /** @@ -993,6 +1002,11 @@ export namespace dialogflow_v2 { * set by Dialogflow-owned servers. */ source?: string; + /** + * Optional. The version of the protocol used for this request. This field + * is AoG-specific. + */ + version?: string; } /** * Represents the result of conversational query or event processing. @@ -1030,7 +1044,9 @@ export namespace dialogflow_v2 { intent?: Schema$GoogleCloudDialogflowV2beta1Intent; /** * The intent detection confidence. Values range from 0.0 (completely - * uncertain) to 1.0 (completely certain). + * uncertain) to 1.0 (completely certain). If there are `multiple + * knowledge_answers` messages, this value is set to the greatest + * `knowledgeAnswers.match_confidence` value in the list. */ intentDetectionConfidence?: number; /** @@ -1201,7 +1217,8 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2DetectIntentResponse { /** - * The results of the conversational query or event processing. + * The selected results of the conversational query or event processing. See + * `alternative_query_results` for additional potential results. */ queryResult?: Schema$GoogleCloudDialogflowV2QueryResult; /** @@ -1312,14 +1329,15 @@ export namespace dialogflow_v2 { export interface Schema$GoogleCloudDialogflowV2ExportAgentResponse { /** * The exported agent. Example for how to export an agent to a zip file via - * a command line: curl \ - * 'https://dialogflow.googleapis.com/v2/projects/<project_name>/agent:export'\ + * a command line: <pre>curl \ + * 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:export'\ * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * print-access-token) \ -H 'Accept: application/json' \ -H - * 'Content-Type: application/json' \ --compressed \ --data-binary - * '{}' \ | grep agentContent | sed -e - * 's/.*"agentContent": "\([^"]*\)".x/\1/' - * \ | base64 --decode > <agent zip file> + * application-default print-access-token) \ -H 'Accept: + * application/json' \ -H 'Content-Type: application/json' \ + * --compressed \ --data-binary '{}' \ | grep agentContent | sed + * -e 's/.*"agentContent": + * "\([^"]*\)".x/\1/' \ | base64 --decode > + * &lt;agent zip file&gt;</pre> */ agentContent?: string; /** @@ -1334,13 +1352,14 @@ export namespace dialogflow_v2 { export interface Schema$GoogleCloudDialogflowV2ImportAgentRequest { /** * The agent to import. Example for how to import an agent via the command - * line: curl \ - * 'https://dialogflow.googleapis.com/v2/projects/<project_name>/agent:import\ + * line: <pre>curl \ + * 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:import\ * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * print-access-token) \ -H 'Accept: application/json' \ -H - * 'Content-Type: application/json' \ --compressed \ - * --data-binary "{ 'agentContent': '$(cat <agent - * zip file> | base64 -w 0)' }" + * application-default print-access-token) \ -H 'Accept: + * application/json' \ -H 'Content-Type: application/json' \ + * --compressed \ --data-binary "{ 'agentContent': + * '$(cat &lt;agent zip file&gt; | base64 -w 0)' + * }"</pre> */ agentContent?: string; /** @@ -1383,11 +1402,12 @@ export namespace dialogflow_v2 { /** * Represents an intent. Intents convert a number of user expressions or * patterns into an action. An action is an extraction of a user command or - * sentence semantics. Next available field number: 22. + * sentence semantics. */ export interface Schema$GoogleCloudDialogflowV2Intent { /** - * Optional. The name of the action associated with the intent. + * Optional. The name of the action associated with the intent. Note: The + * action name must not contain whitespaces. */ action?: string; /** @@ -1993,7 +2013,15 @@ export namespace dialogflow_v2 { export interface Schema$GoogleCloudDialogflowV2OriginalDetectIntentRequest { /** * Optional. This field is set to the value of `QueryParameters.payload` - * field passed in the request. + * field passed in the request. This field is used for the telephony + * gateway. It should have a structure similar to this JSON message: + * <pre>{ "telephony": { "caller_id": + * "+18558363987" }</pre> Note: The caller ID field + * (`caller_id`) will be in [E.164 + * format](https://en.wikipedia.org/wiki/E.164) and is not supported for + * standard tier agents. When the telephony gateway is used with a standard + * tier agent the `caller_id` field above will have a value of + * `REDACTED_IN_STANDARD_TIER_AGENT`. */ payload?: any; /** @@ -2001,6 +2029,11 @@ export namespace dialogflow_v2 { * set by Dialogflow-owned servers. */ source?: string; + /** + * Optional. The version of the protocol used for this request. This field + * is AoG-specific. + */ + version?: string; } /** * Represents the query input. It can contain either: 1. An audio config @@ -2095,7 +2128,9 @@ export namespace dialogflow_v2 { intent?: Schema$GoogleCloudDialogflowV2Intent; /** * The intent detection confidence. Values range from 0.0 (completely - * uncertain) to 1.0 (completely certain). + * uncertain) to 1.0 (completely certain). If there are `multiple + * knowledge_answers` messages, this value is set to the greatest + * `knowledgeAnswers.match_confidence` value in the list. */ intentDetectionConfidence?: number; /** @@ -2151,13 +2186,14 @@ export namespace dialogflow_v2 { export interface Schema$GoogleCloudDialogflowV2RestoreAgentRequest { /** * The agent to restore. Example for how to restore an agent via the - * command line: curl \ - * 'https://dialogflow.googleapis.com/v2/projects/<project_name>/agent:restore\ + * command line: <pre>curl \ + * 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:restore\ * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * print-access-token) \ -H 'Accept: application/json' \ -H - * 'Content-Type: application/json' \ --compressed \ - * --data-binary "{ 'agentContent': '$(cat <agent - * zip file> | base64 -w 0)' }" \ + * application-default print-access-token) \ -H 'Accept: + * application/json' \ -H 'Content-Type: application/json' \ + * --compressed \ --data-binary "{ 'agentContent': + * '$(cat &lt;agent zip file&gt; | base64 -w 0)' + * }"</pre> */ agentContent?: string; /** diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index e302fcfd0ea..0ed3afe7f73 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -313,11 +313,10 @@ export namespace dialogflow_v2beta1 { * `projects/<Project ID>/agent/sessions/<Session * ID>/contexts/<Context ID>`, or `projects/<Project * ID>/agent/environments/<Environment ID>/users/<User - * ID>/sessions/<Session ID>/contexts/<Context ID>`. Note: - * Environments and users are under construction and will be available soon. - * The Context ID is always converted to lowercase. If <Environment - * ID> is not specified, we assume default 'draft' environment. - * If <User ID> is not specified, we assume default '-' user. + * ID>/sessions/<Session ID>/contexts/<Context ID>`. The + * `Context ID` is always converted to lowercase. If `Environment ID` is not + * specified, we assume default 'draft' environment. If `User ID` is + * not specified, we assume default '-' user. */ name?: string; /** @@ -354,7 +353,8 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1DetectIntentResponse { /** - * The results of the conversational query or event processing. + * The selected results of the conversational query or event processing. See + * `alternative_query_results` for additional potential results. */ queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; /** @@ -465,14 +465,15 @@ export namespace dialogflow_v2beta1 { export interface Schema$GoogleCloudDialogflowV2beta1ExportAgentResponse { /** * The exported agent. Example for how to export an agent to a zip file via - * a command line: curl \ - * 'https://dialogflow.googleapis.com/v2beta1/projects/<project_name>/agent:export'\ + * a command line: <pre>curl \ + * 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:export'\ * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * print-access-token) \ -H 'Accept: application/json' \ -H - * 'Content-Type: application/json' \ --compressed \ --data-binary - * '{}' \ | grep agentContent | sed -e - * 's/.*"agentContent": "\([^"]*\)".x/\1/' - * \ | base64 --decode > <agent zip file> + * application-default print-access-token) \ -H 'Accept: + * application/json' \ -H 'Content-Type: application/json' \ + * --compressed \ --data-binary '{}' \ | grep agentContent | sed + * -e 's/.*"agentContent": + * "\([^"]*\)".x/\1/' \ | base64 --decode > + * &lt;agent zip file&gt;</pre> */ agentContent?: string; /** @@ -487,13 +488,14 @@ export namespace dialogflow_v2beta1 { export interface Schema$GoogleCloudDialogflowV2beta1ImportAgentRequest { /** * The agent to import. Example for how to import an agent via the command - * line: curl \ - * 'https://dialogflow.googleapis.com/v2beta1/projects/<project_name>/agent:import\ + * line: <pre>curl \ + * 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:import\ * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * print-access-token) \ -H 'Accept: application/json' \ -H - * 'Content-Type: application/json' \ --compressed \ - * --data-binary "{ 'agentContent': '$(cat <agent - * zip file> | base64 -w 0)' }" + * application-default print-access-token) \ -H 'Accept: + * application/json' \ -H 'Content-Type: application/json' \ + * --compressed \ --data-binary "{ 'agentContent': + * '$(cat &lt;agent zip file&gt; | base64 -w 0)' + * }"</pre> */ agentContent?: string; /** @@ -536,11 +538,12 @@ export namespace dialogflow_v2beta1 { /** * Represents an intent. Intents convert a number of user expressions or * patterns into an action. An action is an extraction of a user command or - * sentence semantics. Next available field number: 22. + * sentence semantics. */ export interface Schema$GoogleCloudDialogflowV2beta1Intent { /** - * Optional. The name of the action associated with the intent. + * Optional. The name of the action associated with the intent. Note: The + * action name must not contain whitespaces. */ action?: string; /** @@ -1169,7 +1172,15 @@ export namespace dialogflow_v2beta1 { export interface Schema$GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest { /** * Optional. This field is set to the value of `QueryParameters.payload` - * field passed in the request. + * field passed in the request. This field is used for the telephony + * gateway. It should have a structure similar to this JSON message: + * <pre>{ "telephony": { "caller_id": + * "+18558363987" }</pre> Note: The caller ID field + * (`caller_id`) will be in [E.164 + * format](https://en.wikipedia.org/wiki/E.164) and is not supported for + * standard tier agents. When the telephony gateway is used with a standard + * tier agent the `caller_id` field above will have a value of + * `REDACTED_IN_STANDARD_TIER_AGENT`. */ payload?: any; /** @@ -1177,6 +1188,11 @@ export namespace dialogflow_v2beta1 { * set by Dialogflow-owned servers. */ source?: string; + /** + * Optional. The version of the protocol used for this request. This field + * is AoG-specific. + */ + version?: string; } /** * Represents the query input. It can contain either: 1. An audio config @@ -1271,7 +1287,9 @@ export namespace dialogflow_v2beta1 { intent?: Schema$GoogleCloudDialogflowV2beta1Intent; /** * The intent detection confidence. Values range from 0.0 (completely - * uncertain) to 1.0 (completely certain). + * uncertain) to 1.0 (completely certain). If there are `multiple + * knowledge_answers` messages, this value is set to the greatest + * `knowledgeAnswers.match_confidence` value in the list. */ intentDetectionConfidence?: number; /** @@ -1327,13 +1345,14 @@ export namespace dialogflow_v2beta1 { export interface Schema$GoogleCloudDialogflowV2beta1RestoreAgentRequest { /** * The agent to restore. Example for how to restore an agent via the - * command line: curl \ - * 'https://dialogflow.googleapis.com/v2beta1/projects/<project_name>/agent:restore\ + * command line: <pre>curl \ + * 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:restore\ * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * print-access-token) \ -H 'Accept: application/json' \ -H - * 'Content-Type: application/json' \ --compressed \ - * --data-binary "{ 'agentContent': '$(cat <agent - * zip file> | base64 -w 0)' }" \ + * application-default print-access-token) \ -H 'Accept: + * application/json' \ -H 'Content-Type: application/json' \ + * --compressed \ --data-binary "{ 'agentContent': + * '$(cat &lt;agent zip file&gt; | base64 -w 0)' + * }"</pre> */ agentContent?: string; /** @@ -1379,12 +1398,10 @@ export namespace dialogflow_v2beta1 { * `projects/<Project ID>/agent/sessions/<Session * ID>/entityTypes/<Entity Type Display Name>`, or * `projects/<Project ID>/agent/environments/<Environment - * ID>/users/<User ID>/sessions /<Session - * ID>/entityTypes/<Entity Type Display Name>`. Note: Environments - * and users are under construction and will be available soon. If - * <Environment ID> is not specified, we assume default - * 'draft' environment. If <User ID> is not specified, we - * assume default '-' user. + * ID>/users/<User ID>/sessions/<Session + * ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` + * is not specified, we assume default 'draft' environment. If `User + * ID` is not specified, we assume default '-' user. */ name?: string; } @@ -1578,14 +1595,15 @@ export namespace dialogflow_v2beta1 { export interface Schema$GoogleCloudDialogflowV2ExportAgentResponse { /** * The exported agent. Example for how to export an agent to a zip file via - * a command line: curl \ - * 'https://dialogflow.googleapis.com/v2/projects/<project_name>/agent:export'\ + * a command line: <pre>curl \ + * 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:export'\ * -X POST \ -H 'Authorization: Bearer '$(gcloud auth - * print-access-token) \ -H 'Accept: application/json' \ -H - * 'Content-Type: application/json' \ --compressed \ --data-binary - * '{}' \ | grep agentContent | sed -e - * 's/.*"agentContent": "\([^"]*\)".x/\1/' - * \ | base64 --decode > <agent zip file> + * application-default print-access-token) \ -H 'Accept: + * application/json' \ -H 'Content-Type: application/json' \ + * --compressed \ --data-binary '{}' \ | grep agentContent | sed + * -e 's/.*"agentContent": + * "\([^"]*\)".x/\1/' \ | base64 --decode > + * &lt;agent zip file&gt;</pre> */ agentContent?: string; /** @@ -1597,11 +1615,12 @@ export namespace dialogflow_v2beta1 { /** * Represents an intent. Intents convert a number of user expressions or * patterns into an action. An action is an extraction of a user command or - * sentence semantics. Next available field number: 22. + * sentence semantics. */ export interface Schema$GoogleCloudDialogflowV2Intent { /** - * Optional. The name of the action associated with the intent. + * Optional. The name of the action associated with the intent. Note: The + * action name must not contain whitespaces. */ action?: string; /** @@ -2138,7 +2157,15 @@ export namespace dialogflow_v2beta1 { export interface Schema$GoogleCloudDialogflowV2OriginalDetectIntentRequest { /** * Optional. This field is set to the value of `QueryParameters.payload` - * field passed in the request. + * field passed in the request. This field is used for the telephony + * gateway. It should have a structure similar to this JSON message: + * <pre>{ "telephony": { "caller_id": + * "+18558363987" }</pre> Note: The caller ID field + * (`caller_id`) will be in [E.164 + * format](https://en.wikipedia.org/wiki/E.164) and is not supported for + * standard tier agents. When the telephony gateway is used with a standard + * tier agent the `caller_id` field above will have a value of + * `REDACTED_IN_STANDARD_TIER_AGENT`. */ payload?: any; /** @@ -2146,6 +2173,11 @@ export namespace dialogflow_v2beta1 { * set by Dialogflow-owned servers. */ source?: string; + /** + * Optional. The version of the protocol used for this request. This field + * is AoG-specific. + */ + version?: string; } /** * Represents the result of conversational query or event processing. @@ -2183,7 +2215,9 @@ export namespace dialogflow_v2beta1 { intent?: Schema$GoogleCloudDialogflowV2Intent; /** * The intent detection confidence. Values range from 0.0 (completely - * uncertain) to 1.0 (completely certain). + * uncertain) to 1.0 (completely certain). If there are `multiple + * knowledge_answers` messages, this value is set to the greatest + * `knowledgeAnswers.match_confidence` value in the list. */ intentDetectionConfidence?: number; /** @@ -4044,7 +4078,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be available soon. If is not specified we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.parent Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4120,7 +4154,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.session Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we are using "-". It’s up to the API caller to choose an appropriate and . They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the and must not exceed 36 characters. + * @param {string} params.session Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using "-". It’s up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. * @param {().GoogleCloudDialogflowV2beta1DetectIntentRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4208,10 +4242,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The name of the session to delete all contexts from. Format: * `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be - * available soon. If is not specified we assume default - * 'draft' environment. If is not specified, we assume default '-' - * user. + * ID>`. If `Environment ID` is not specified we assume default 'draft' + * environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; } @@ -4225,13 +4257,12 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The name of the session this query is sent to. Format: * `projects//agent/sessions/`, or * `projects//agent/environments//users//sessions/`. Note: Environments and users are under - * construction and will be available soon. If is not - * specified, we assume default 'draft' environment. If is not - * specified, we are using "-". It’s up to the API caller to choose an - * appropriate and . They can be a random numbers or - * some type of user and session identifiers (preferably hashed). The length - * of the and must not exceed 36 characters. + * ID>/sessions/`. If `Environment ID` is not specified, we + * assume default 'draft' environment. If `User ID` is not specified, we are + * using "-". It’s up to the API caller to choose an appropriate `Session + * ID` and `User Id`. They can be a random numbers or some type of user and + * session identifiers (preferably hashed). The length of the `Session ID` + * and `User ID` must not exceed 36 characters. */ session?: string; @@ -4261,7 +4292,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.parent Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {().GoogleCloudDialogflowV2beta1Context} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4347,7 +4378,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.name Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4418,7 +4449,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.name Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4499,7 +4530,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.parent Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4583,7 +4614,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. Note: Environments and users are under construction and will be available soon. The Context ID is always converted to lowercase. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. * @param {().GoogleCloudDialogflowV2beta1Context} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4670,10 +4701,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be - * available soon. If is not specified, we assume default - * 'draft' environment. If is not specified, we assume default '-' - * user. + * ID>`. If `Environment ID` is not specified, we assume default 'draft' + * environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; @@ -4692,10 +4721,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or * `projects//agent/environments//users//sessions//contexts/`. Note: Environments and - * users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If - * is not specified, we assume default '-' user. + * ID>/sessions//contexts/`. If `Environment ID` is + * not specified, we assume default 'draft' environment. If `User ID` is not + * specified, we assume default '-' user. */ name?: string; } @@ -4709,10 +4737,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The name of the context. Format: `projects//agent/sessions//contexts/` or * `projects//agent/environments//users//sessions//contexts/`. Note: Environments and - * users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If - * is not specified, we assume default '-' user. + * ID>/sessions//contexts/`. If `Environment ID` is + * not specified, we assume default 'draft' environment. If `User ID` is not + * specified, we assume default '-' user. */ name?: string; } @@ -4736,10 +4763,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The session to list all contexts from. Format: * `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be - * available soon. If is not specified, we assume default - * 'draft' environment. If is not specified, we assume default '-' - * user. + * ID>`. If `Environment ID` is not specified, we assume default 'draft' + * environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; } @@ -4753,10 +4778,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The unique identifier of the context. Format: * `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. Note: - * Environments and users are under construction and will be available soon. - * The Context ID is always converted to lowercase. If is - * not specified, we assume default 'draft' environment. If is not + * ID>/users//sessions//contexts/`. The + * `Context ID` is always converted to lowercase. If `Environment ID` is not + * specified, we assume default 'draft' environment. If `User ID` is not * specified, we assume default '-' user. */ name?: string; @@ -4792,7 +4816,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The session to create a session entity type for. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.parent Required. The session to create a session entity type for. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {().GoogleCloudDialogflowV2beta1SessionEntityType} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4875,7 +4899,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the entity type to delete. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.name Required. The name of the entity type to delete. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4947,7 +4971,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions// entityTypes/`. Note: Environments and users re under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.name Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5027,7 +5051,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The session to list all session entity types from. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.parent Required. The session to list all session entity types from. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5116,7 +5140,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions //entityTypes/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.name Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. * @param {().GoogleCloudDialogflowV2beta1SessionEntityType} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5201,10 +5225,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The session to create a session entity type for. Format: * `projects//agent/sessions/` or `projects//agent/environments//users// - * sessions/`. Note: Environments and users are under - * construction and will be available soon. If is not - * specified, we assume default 'draft' environment. If is not - * specified, we assume default '-' user. + * sessions/`. If `Environment ID` is not specified, we assume + * default 'draft' environment. If `User ID` is not specified, we assume + * default '-' user. */ parent?: string; @@ -5224,9 +5247,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. Note: Environments and users - * are under construction and will be available soon. If is - * not specified, we assume default 'draft' environment. If is not + * ID>/entityTypes/`. If `Environment ID` is not + * specified, we assume default 'draft' environment. If `User ID` is not * specified, we assume default '-' user. */ name?: string; @@ -5241,10 +5263,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` * or `projects//agent/environments//users//sessions// entityTypes/`. Note: - * Environments and users re under construction and will be available soon. - * If is not specified, we assume default 'draft' - * environment. If is not specified, we assume default '-' user. + * ID>/sessions//entityTypes/`. If + * `Environment ID` is not specified, we assume default 'draft' environment. + * If `User ID` is not specified, we assume default '-' user. */ name?: string; } @@ -5268,10 +5289,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The session to list all session entity types from. Format: * `projects//agent/sessions/` or `projects//agent/environments//users// - * sessions/`. Note: Environments and users are under - * construction and will be available soon. If is not - * specified, we assume default 'draft' environment. If is not - * specified, we assume default '-' user. + * sessions/`. If `Environment ID` is not specified, we assume + * default 'draft' environment. If `User ID` is not specified, we assume + * default '-' user. */ parent?: string; } @@ -5285,11 +5305,10 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The unique identifier of this session entity type. Format: * `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions - * //entityTypes/`. Note: Environments - * and users are under construction and will be available soon. If - * is not specified, we assume default 'draft' environment. - * If is not specified, we assume default '-' user. + * ID>/agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not + * specified, we assume default 'draft' environment. If `User ID` is not + * specified, we assume default '-' user. */ name?: string; /** @@ -6045,7 +6064,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be available soon. If is not specified we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.parent Required. The name of the session to delete all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6117,7 +6136,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.session Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we are using "-". It’s up to the API caller to choose an appropriate and . They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the and must not exceed 36 characters. + * @param {string} params.session Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using "-". It’s up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random numbers or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. * @param {().GoogleCloudDialogflowV2beta1DetectIntentRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6200,10 +6219,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The name of the session to delete all contexts from. Format: * `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be - * available soon. If is not specified we assume default - * 'draft' environment. If is not specified, we assume default '-' - * user. + * ID>`. If `Environment ID` is not specified we assume default 'draft' + * environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; } @@ -6217,13 +6234,12 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The name of the session this query is sent to. Format: * `projects//agent/sessions/`, or * `projects//agent/environments//users//sessions/`. Note: Environments and users are under - * construction and will be available soon. If is not - * specified, we assume default 'draft' environment. If is not - * specified, we are using "-". It’s up to the API caller to choose an - * appropriate and . They can be a random numbers or - * some type of user and session identifiers (preferably hashed). The length - * of the and must not exceed 36 characters. + * ID>/sessions/`. If `Environment ID` is not specified, we + * assume default 'draft' environment. If `User ID` is not specified, we are + * using "-". It’s up to the API caller to choose an appropriate `Session + * ID` and `User Id`. They can be a random numbers or some type of user and + * session identifiers (preferably hashed). The length of the `Session ID` + * and `User ID` must not exceed 36 characters. */ session?: string; @@ -6252,7 +6268,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.parent Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {().GoogleCloudDialogflowV2beta1Context} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6333,7 +6349,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.name Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6400,7 +6416,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.name Required. The name of the context. Format: `projects//agent/sessions//contexts/` or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6475,7 +6491,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.parent Required. The session to list all contexts from. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6554,7 +6570,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. Note: Environments and users are under construction and will be available soon. The Context ID is always converted to lowercase. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. * @param {().GoogleCloudDialogflowV2beta1Context} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6637,10 +6653,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The session to create a context for. Format: `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be - * available soon. If is not specified, we assume default - * 'draft' environment. If is not specified, we assume default '-' - * user. + * ID>`. If `Environment ID` is not specified, we assume default 'draft' + * environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; @@ -6659,10 +6673,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The name of the context to delete. Format: `projects//agent/sessions//contexts/` or * `projects//agent/environments//users//sessions//contexts/`. Note: Environments and - * users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If - * is not specified, we assume default '-' user. + * ID>/sessions//contexts/`. If `Environment ID` is + * not specified, we assume default 'draft' environment. If `User ID` is not + * specified, we assume default '-' user. */ name?: string; } @@ -6676,10 +6689,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The name of the context. Format: `projects//agent/sessions//contexts/` or * `projects//agent/environments//users//sessions//contexts/`. Note: Environments and - * users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If - * is not specified, we assume default '-' user. + * ID>/sessions//contexts/`. If `Environment ID` is + * not specified, we assume default 'draft' environment. If `User ID` is not + * specified, we assume default '-' user. */ name?: string; } @@ -6703,10 +6715,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The session to list all contexts from. Format: * `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. Note: Environments and users are under construction and will be - * available soon. If is not specified, we assume default - * 'draft' environment. If is not specified, we assume default '-' - * user. + * ID>`. If `Environment ID` is not specified, we assume default 'draft' + * environment. If `User ID` is not specified, we assume default '-' user. */ parent?: string; } @@ -6720,10 +6730,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The unique identifier of the context. Format: * `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. Note: - * Environments and users are under construction and will be available soon. - * The Context ID is always converted to lowercase. If is - * not specified, we assume default 'draft' environment. If is not + * ID>/users//sessions//contexts/`. The + * `Context ID` is always converted to lowercase. If `Environment ID` is not + * specified, we assume default 'draft' environment. If `User ID` is not * specified, we assume default '-' user. */ name?: string; @@ -6758,7 +6767,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The session to create a session entity type for. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.parent Required. The session to create a session entity type for. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {().GoogleCloudDialogflowV2beta1SessionEntityType} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6837,7 +6846,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the entity type to delete. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.name Required. The name of the entity type to delete. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6905,7 +6914,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions// entityTypes/`. Note: Environments and users re under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.name Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6980,7 +6989,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. - * @param {string} params.parent Required. The session to list all session entity types from. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.parent Required. The session to list all session entity types from. Format: `projects//agent/sessions/` or `projects//agent/environments//users// sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7064,7 +7073,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions //entityTypes/`. Note: Environments and users are under construction and will be available soon. If is not specified, we assume default 'draft' environment. If is not specified, we assume default '-' user. + * @param {string} params.name Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. * @param {().GoogleCloudDialogflowV2beta1SessionEntityType} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7146,10 +7155,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The session to create a session entity type for. Format: * `projects//agent/sessions/` or `projects//agent/environments//users// - * sessions/`. Note: Environments and users are under - * construction and will be available soon. If is not - * specified, we assume default 'draft' environment. If is not - * specified, we assume default '-' user. + * sessions/`. If `Environment ID` is not specified, we assume + * default 'draft' environment. If `User ID` is not specified, we assume + * default '-' user. */ parent?: string; @@ -7169,9 +7177,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. Note: Environments and users - * are under construction and will be available soon. If is - * not specified, we assume default 'draft' environment. If is not + * ID>/entityTypes/`. If `Environment ID` is not + * specified, we assume default 'draft' environment. If `User ID` is not * specified, we assume default '-' user. */ name?: string; @@ -7186,10 +7193,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The name of the session entity type. Format: `projects//agent/sessions//entityTypes/` * or `projects//agent/environments//users//sessions// entityTypes/`. Note: - * Environments and users re under construction and will be available soon. - * If is not specified, we assume default 'draft' - * environment. If is not specified, we assume default '-' user. + * ID>/sessions//entityTypes/`. If + * `Environment ID` is not specified, we assume default 'draft' environment. + * If `User ID` is not specified, we assume default '-' user. */ name?: string; } @@ -7213,10 +7219,9 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The session to list all session entity types from. Format: * `projects//agent/sessions/` or `projects//agent/environments//users// - * sessions/`. Note: Environments and users are under - * construction and will be available soon. If is not - * specified, we assume default 'draft' environment. If is not - * specified, we assume default '-' user. + * sessions/`. If `Environment ID` is not specified, we assume + * default 'draft' environment. If `User ID` is not specified, we assume + * default '-' user. */ parent?: string; } @@ -7230,11 +7235,10 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The unique identifier of this session entity type. Format: * `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions - * //entityTypes/`. Note: Environments - * and users are under construction and will be available soon. If - * is not specified, we assume default 'draft' environment. - * If is not specified, we assume default '-' user. + * ID>/agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not + * specified, we assume default 'draft' environment. If `User ID` is not + * specified, we assume default '-' user. */ name?: string; /** diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index c1972c44421..3c2edec103f 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -1124,12 +1124,12 @@ export namespace dlp_v2 { */ createTime?: string; /** - * The type of content that might have been found. Provided if requested by - * the `InspectConfig`. + * The type of content that might have been found. Provided if + * `excluded_types` is false. */ infoType?: Schema$GooglePrivacyDlpV2InfoType; /** - * Estimate of how likely it is that the `info_type` is correct. + * Confidence of how likely it is that the `info_type` is correct. */ likelihood?: string; /** @@ -1138,9 +1138,9 @@ export namespace dlp_v2 { location?: Schema$GooglePrivacyDlpV2Location; /** * The content that was found. Even if the content is not textual, it may be - * converted to a textual representation here. Provided if requested by the - * `InspectConfig` and the finding is less than or equal to 4096 bytes long. - * If the finding exceeds 4096 bytes in length, the quote may be omitted. + * converted to a textual representation here. Provided if `include_quote` + * is true and the finding is less than or equal to 4096 bytes long. If the + * finding exceeds 4096 bytes in length, the quote may be omitted. */ quote?: string; /** @@ -1377,7 +1377,10 @@ export namespace dlp_v2 { /** * Restricts what info_types to look for. The values must correspond to * InfoType values returned by ListInfoTypes or listed at - * https://cloud.google.com/dlp/docs/infotypes-reference. + * https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes + * or CustomInfoTypes are specified in a request, the system may + * automatically choose what detectors to run. By default this may be all + * types, but may change over time as detectors are updated. */ infoTypes?: Schema$GooglePrivacyDlpV2InfoType[]; limits?: Schema$GooglePrivacyDlpV2FindingLimits; @@ -2249,6 +2252,11 @@ export namespace dlp_v2 { * The configuration for specifying what content to redact from images. */ imageRedactionConfigs?: Schema$GooglePrivacyDlpV2ImageRedactionConfig[]; + /** + * Whether the response should include findings along with the redacted + * image. + */ + includeFindings?: boolean; /** * Configuration for the inspector. */ @@ -2264,6 +2272,10 @@ export namespace dlp_v2 { * found in the image. */ extractedText?: string; + /** + * The findings. Populated when include_findings in the request is true. + */ + inspectResult?: Schema$GooglePrivacyDlpV2InspectResult; /** * The redacted image. The type will be the same as the original image. */ @@ -3971,7 +3983,10 @@ export namespace dlp_v2 { * @desc De-identifies potentially sensitive info from a ContentItem. This * method has limits on input size and output size. See * https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn - * more. + * more. When no InfoTypes or CustomInfoTypes are specified in this + * request, the system will automatically choose what detectors to run. By + * default this may be all types, but may change over time as detectors are + * updated. * @alias dlp.projects.content.deidentify * @memberOf! () * @@ -4049,8 +4064,11 @@ export namespace dlp_v2 { /** * dlp.projects.content.inspect * @desc Finds potentially sensitive info in content. This method has limits - * on input size, processing time, and output size. For how to guides, see - * https://cloud.google.com/dlp/docs/inspecting-images and + * on input size, processing time, and output size. When no InfoTypes or + * CustomInfoTypes are specified in this request, the system will + * automatically choose what detectors to run. By default this may be all + * types, but may change over time as detectors are updated. For how to + * guides, see https://cloud.google.com/dlp/docs/inspecting-images and * https://cloud.google.com/dlp/docs/inspecting-text, * @alias dlp.projects.content.inspect * @memberOf! () @@ -4823,6 +4841,9 @@ export namespace dlp_v2 { * @desc Creates a new job to inspect storage or calculate risk metrics. See * https://cloud.google.com/dlp/docs/inspecting-storage and * https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. + * When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the + * system will automatically choose what detectors to run. By default this + * may be all types, but may change over time as detectors are updated. * @alias dlp.projects.dlpJobs.create * @memberOf! () * @@ -5223,7 +5244,10 @@ export namespace dlp_v2 { * @desc Redacts potentially sensitive info from an image. This method has * limits on input size, processing time, and output size. See * https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to - * learn more. + * learn more. When no InfoTypes or CustomInfoTypes are specified in this + * request, the system will automatically choose what detectors to run. By + * default this may be all types, but may change over time as detectors are + * updated. * @alias dlp.projects.image.redact * @memberOf! () * diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 777ca598fc5..c8549074368 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -749,6 +749,11 @@ export namespace drive_v2 { * Deprecated: use capabilities/canCopy. */ copyable?: boolean; + /** + * Whether the options to copy, print, or download this file, should be + * disabled for readers and commenters. + */ + copyRequiresWriterPermission?: boolean; /** * Create time for this file (formatted RFC 3339 timestamp). */ @@ -1500,8 +1505,8 @@ export namespace drive_v2 { */ createdDate?: string; /** - * The ID of this Team Drive which is also the ID of the top level folder - * for this Team Drive. + * The ID of this Team Drive which is also the ID of the top level folder of + * this Team Drive. */ id?: string; /** @@ -1512,6 +1517,11 @@ export namespace drive_v2 { * The name of this Team Drive. */ name?: string; + /** + * A set of restrictions that apply to this Team Drive or items inside this + * Team Drive. + */ + restrictions?: any; /** * The ID of the theme from which the background image and color will be * set. The set of possible teamDriveThemes can be retrieved from a @@ -5172,7 +5182,7 @@ export namespace drive_v2 { * @param {string} params.fileId The ID for the file or Team Drive. * @param {string} params.permissionId The ID for the permission. * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5241,7 +5251,7 @@ export namespace drive_v2 { * @param {string} params.fileId The ID for the file or Team Drive. * @param {string} params.permissionId The ID for the permission. * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5375,7 +5385,7 @@ export namespace drive_v2 { * @param {string} params.fileId The ID for the file or Team Drive. * @param {boolean=} params.sendNotificationEmails Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner. * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. * @param {().Permission} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5447,7 +5457,7 @@ export namespace drive_v2 { * @param {integer=} params.maxResults The maximum number of permissions to return per page. When not set for files in a Team Drive, at most 100 results will be returned. When not set for files that are not in a Team Drive, the entire list will be returned. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5517,7 +5527,7 @@ export namespace drive_v2 { * @param {boolean=} params.removeExpiration Whether to remove the expiration date. * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. * @param {boolean=} params.transferOwnership Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'. - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. * @param {().Permission} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5590,7 +5600,7 @@ export namespace drive_v2 { * @param {boolean=} params.removeExpiration Whether to remove the expiration date. * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. * @param {boolean=} params.transferOwnership Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'. - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. * @param {().Permission} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5671,9 +5681,9 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then the requester will be granted access - * if they are an administrator of the domain to which the item belongs. + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the item belongs. */ useDomainAdminAccess?: boolean; } @@ -5696,9 +5706,9 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then the requester will be granted access - * if they are an administrator of the domain to which the item belongs. + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the item belongs. */ useDomainAdminAccess?: boolean; } @@ -5737,9 +5747,9 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then the requester will be granted access - * if they are an administrator of the domain to which the item belongs. + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the item belongs. */ useDomainAdminAccess?: boolean; @@ -5774,9 +5784,9 @@ export namespace drive_v2 { */ supportsTeamDrives?: boolean; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then the requester will be granted access - * if they are an administrator of the domain to which the item belongs. + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the item belongs. */ useDomainAdminAccess?: boolean; } @@ -5808,9 +5818,9 @@ export namespace drive_v2 { */ transferOwnership?: boolean; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then the requester will be granted access - * if they are an administrator of the domain to which the item belongs. + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the item belongs. */ useDomainAdminAccess?: boolean; @@ -5847,9 +5857,9 @@ export namespace drive_v2 { */ transferOwnership?: boolean; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then the requester will be granted access - * if they are an administrator of the domain to which the item belongs. + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the item belongs. */ useDomainAdminAccess?: boolean; @@ -7667,7 +7677,7 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string} params.teamDriveId The ID of the Team Drive - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7799,7 +7809,7 @@ export namespace drive_v2 { * @param {integer=} params.maxResults Maximum number of Team Drives to return. * @param {string=} params.pageToken Page token for Team Drives. * @param {string=} params.q Query string for searching Team Drives. - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -7865,6 +7875,7 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string} params.teamDriveId The ID of the Team Drive + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. * @param {().TeamDrive} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7946,10 +7957,9 @@ export namespace drive_v2 { */ teamDriveId?: string; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then the requester will be granted access - * if they are an administrator of the domain to which the Team Drive - * belongs. + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the Team Drive belongs. */ useDomainAdminAccess?: boolean; } @@ -7992,9 +8002,9 @@ export namespace drive_v2 { */ q?: string; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then all Team Drives of the domain in - * which the requester is an administrator are returned. + * Issue the request as a domain administrator; if set to true, then all + * Team Drives of the domain in which the requester is an administrator are + * returned. */ useDomainAdminAccess?: boolean; } @@ -8008,6 +8018,12 @@ export namespace drive_v2 { * The ID of the Team Drive */ teamDriveId?: string; + /** + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the Team Drive belongs. + */ + useDomainAdminAccess?: boolean; /** * Request body metadata diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 92725bc7b0f..bea2707e813 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -353,6 +353,11 @@ export namespace drive_v3 { * never populated in responses. */ contentHints?: any; + /** + * Whether the options to copy, print, or download this file, should be + * disabled for readers and commenters. + */ + copyRequiresWriterPermission?: boolean; /** * The time at which the file was created (RFC 3339 date-time). */ @@ -581,8 +586,7 @@ export namespace drive_v3 { */ viewedByMeTime?: string; /** - * Whether users with only reader or commenter permission can copy the - * file's content. This affects copy, download, and print operations. + * Deprecated - use copyRequiresWriterPermission instead. */ viewersCanCopyContent?: boolean; /** @@ -932,8 +936,8 @@ export namespace drive_v3 { */ createdTime?: string; /** - * The ID of this Team Drive which is also the ID of the top level folder - * for this Team Drive. + * The ID of this Team Drive which is also the ID of the top level folder of + * this Team Drive. */ id?: string; /** @@ -945,6 +949,11 @@ export namespace drive_v3 { * The name of this Team Drive. */ name?: string; + /** + * A set of restrictions that apply to this Team Drive or items inside this + * Team Drive. + */ + restrictions?: any; /** * The ID of the theme from which the background image and color will be * set. The set of possible teamDriveThemes can be retrieved from a @@ -3007,7 +3016,7 @@ export namespace drive_v3 { * @param {boolean=} params.sendNotificationEmail Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. * @param {boolean=} params.transferOwnership Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. * @param {().Permission} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3078,7 +3087,7 @@ export namespace drive_v3 { * @param {string} params.fileId The ID of the file or Team Drive. * @param {string} params.permissionId The ID of the permission. * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3147,7 +3156,7 @@ export namespace drive_v3 { * @param {string} params.fileId The ID of the file. * @param {string} params.permissionId The ID of the permission. * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3214,7 +3223,7 @@ export namespace drive_v3 { * @param {integer=} params.pageSize The maximum number of permissions to return per page. When not set for files in a Team Drive, at most 100 results will be returned. When not set for files that are not in a Team Drive, the entire list will be returned. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3284,7 +3293,7 @@ export namespace drive_v3 { * @param {boolean=} params.removeExpiration Whether to remove the expiration date. * @param {boolean=} params.supportsTeamDrives Whether the requesting application supports Team Drives. * @param {boolean=} params.transferOwnership Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. * @param {().Permission} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3377,9 +3386,9 @@ export namespace drive_v3 { */ transferOwnership?: boolean; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then the requester will be granted access - * if they are an administrator of the domain to which the item belongs. + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the item belongs. */ useDomainAdminAccess?: boolean; @@ -3407,9 +3416,9 @@ export namespace drive_v3 { */ supportsTeamDrives?: boolean; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then the requester will be granted access - * if they are an administrator of the domain to which the item belongs. + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the item belongs. */ useDomainAdminAccess?: boolean; } @@ -3432,9 +3441,9 @@ export namespace drive_v3 { */ supportsTeamDrives?: boolean; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then the requester will be granted access - * if they are an administrator of the domain to which the item belongs. + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the item belongs. */ useDomainAdminAccess?: boolean; } @@ -3464,9 +3473,9 @@ export namespace drive_v3 { */ supportsTeamDrives?: boolean; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then the requester will be granted access - * if they are an administrator of the domain to which the item belongs. + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the item belongs. */ useDomainAdminAccess?: boolean; } @@ -3499,9 +3508,9 @@ export namespace drive_v3 { */ transferOwnership?: boolean; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then the requester will be granted access - * if they are an administrator of the domain to which the item belongs. + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the item belongs. */ useDomainAdminAccess?: boolean; @@ -4483,7 +4492,7 @@ export namespace drive_v3 { * * @param {object} params Parameters for request * @param {string} params.teamDriveId The ID of the Team Drive - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4548,7 +4557,7 @@ export namespace drive_v3 { * @param {integer=} params.pageSize Maximum number of Team Drives to return. * @param {string=} params.pageToken Page token for Team Drives. * @param {string=} params.q Query string for searching Team Drives. - * @param {boolean=} params.useDomainAdminAccess Whether the request should be treated as if it was issued by a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned. + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4614,6 +4623,7 @@ export namespace drive_v3 { * * @param {object} params Parameters for request * @param {string} params.teamDriveId The ID of the Team Drive + * @param {boolean=} params.useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. * @param {().TeamDrive} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4715,10 +4725,9 @@ export namespace drive_v3 { */ teamDriveId?: string; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then the requester will be granted access - * if they are an administrator of the domain to which the Team Drive - * belongs. + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the Team Drive belongs. */ useDomainAdminAccess?: boolean; } @@ -4741,9 +4750,9 @@ export namespace drive_v3 { */ q?: string; /** - * Whether the request should be treated as if it was issued by a domain - * administrator; if set to true, then all Team Drives of the domain in - * which the requester is an administrator are returned. + * Issue the request as a domain administrator; if set to true, then all + * Team Drives of the domain in which the requester is an administrator are + * returned. */ useDomainAdminAccess?: boolean; } @@ -4757,6 +4766,12 @@ export namespace drive_v3 { * The ID of the Team Drive */ teamDriveId?: string; + /** + * Issue the request as a domain administrator; if set to true, then the + * requester will be granted access if they are an administrator of the + * domain to which the Team Drive belongs. + */ + useDomainAdminAccess?: boolean; /** * Request body metadata diff --git a/src/apis/firestore/index.ts b/src/apis/firestore/index.ts index 7c6301500b3..526b46b4e11 100644 --- a/src/apis/firestore/index.ts +++ b/src/apis/firestore/index.ts @@ -14,17 +14,30 @@ /*! THIS FILE IS AUTO-GENERATED */ import {getAPI, GoogleConfigurable} from '../../shared/src'; +import {firestore_v1} from './v1'; import {firestore_v1beta1} from './v1beta1'; +import {firestore_v1beta2} from './v1beta2'; export const VERSIONS = { + 'v1': firestore_v1.Firestore, 'v1beta1': firestore_v1beta1.Firestore, + 'v1beta2': firestore_v1beta2.Firestore, }; +export function firestore(version: 'v1'): firestore_v1.Firestore; +export function firestore(options: firestore_v1.Options): + firestore_v1.Firestore; export function firestore(version: 'v1beta1'): firestore_v1beta1.Firestore; export function firestore(options: firestore_v1beta1.Options): firestore_v1beta1.Firestore; -export function firestore( +export function firestore(version: 'v1beta2'): firestore_v1beta2.Firestore; +export function firestore(options: firestore_v1beta2.Options): + firestore_v1beta2.Firestore; +export function firestore< + T = firestore_v1.Firestore | firestore_v1beta1.Firestore | + firestore_v1beta2.Firestore>( this: GoogleConfigurable, - versionOrOptions: 'v1beta1'|firestore_v1beta1.Options) { + versionOrOptions: 'v1'|firestore_v1.Options|'v1beta1'| + firestore_v1beta1.Options|'v1beta2'|firestore_v1beta2.Options) { return getAPI('firestore', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts new file mode 100644 index 00000000000..bfb04e60726 --- /dev/null +++ b/src/apis/firestore/v1.ts @@ -0,0 +1,558 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {AxiosPromise} from 'axios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; + +import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from '../../shared/src'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace firestore_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + /** + * Cloud Firestore API + * + * + * + * @example + * const {google} = require('googleapis'); + * const firestore = google.firestore('v1'); + * + * @namespace firestore + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Firestore + */ + export class Firestore { + _options: GlobalOptions; + google?: GoogleConfigurable; + root = this; + + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.projects = new Resource$Projects(this); + } + + getRoot() { + return this.root; + } + } + + /** + * Metadata for ExportDocuments operations. + */ + export interface Schema$GoogleFirestoreAdminV1beta1ExportDocumentsMetadata { + /** + * Which collection ids are being exported. + */ + collectionIds?: string[]; + /** + * The time the operation ended, either successfully or otherwise. Unset if + * the operation is still active. + */ + endTime?: string; + /** + * The state of the export operation. + */ + operationState?: string; + /** + * Where the entities are being exported to. + */ + outputUriPrefix?: string; + /** + * An estimate of the number of bytes processed. + */ + progressBytes?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * An estimate of the number of documents processed. + */ + progressDocuments?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * The time that work began on the operation. + */ + startTime?: string; + } + /** + * Returned in the google.longrunning.Operation response field. + */ + export interface Schema$GoogleFirestoreAdminV1beta1ExportDocumentsResponse { + /** + * Location of the output files. This can be used to begin an import into + * Cloud Firestore (this project or another project) after the operation + * completes successfully. + */ + outputUriPrefix?: string; + } + /** + * Metadata for ImportDocuments operations. + */ + export interface Schema$GoogleFirestoreAdminV1beta1ImportDocumentsMetadata { + /** + * Which collection ids are being imported. + */ + collectionIds?: string[]; + /** + * The time the operation ended, either successfully or otherwise. Unset if + * the operation is still active. + */ + endTime?: string; + /** + * The location of the documents being imported. + */ + inputUriPrefix?: string; + /** + * The state of the import operation. + */ + operationState?: string; + /** + * An estimate of the number of bytes processed. + */ + progressBytes?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * An estimate of the number of documents processed. + */ + progressDocuments?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * The time that work began on the operation. + */ + startTime?: string; + } + /** + * Metadata for index operations. This metadata populates the metadata field + * of google.longrunning.Operation. + */ + export interface Schema$GoogleFirestoreAdminV1beta1IndexOperationMetadata { + /** + * True if the [google.longrunning.Operation] was cancelled. If the + * cancellation is in progress, cancelled will be true but + * google.longrunning.Operation.done will be false. + */ + cancelled?: boolean; + /** + * Progress of the existing operation, measured in number of documents. + */ + documentProgress?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * The time the operation ended, either successfully or otherwise. Unset if + * the operation is still active. + */ + endTime?: string; + /** + * The index resource that this operation is acting on. For example: + * `projects/{project_id}/databases/{database_id}/indexes/{index_id}` + */ + index?: string; + /** + * The type of index operation. + */ + operationType?: string; + /** + * The time that work began on the operation. + */ + startTime?: string; + } + /** + * The metadata message for google.cloud.location.Location.metadata. + */ + export interface Schema$GoogleFirestoreAdminV1beta1LocationMetadata {} + /** + * Measures the progress of a particular metric. + */ + export interface Schema$GoogleFirestoreAdminV1beta1Progress { + /** + * An estimate of how much work has been completed. Note that this may be + * greater than `work_estimated`. + */ + workCompleted?: string; + /** + * An estimate of how much work needs to be performed. Zero if the work + * estimate is unavailable. May change as work progresses. + */ + workEstimated?: string; + } + /** + * Metadata for google.longrunning.Operation results from + * FirestoreAdmin.UpdateField. + */ + export interface Schema$GoogleFirestoreAdminV1beta2FieldOperationMetadata { + /** + * The progress, in bytes, of this operation. + */ + bytesProgress?: Schema$GoogleFirestoreAdminV1beta2Progress; + /** + * The progress, in documents, of this operation. + */ + documentProgress?: Schema$GoogleFirestoreAdminV1beta2Progress; + /** + * The time this operation completed. Will be unset if operation still in + * progress. + */ + endTime?: string; + /** + * The field resource that this operation is acting on. For example: + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` + */ + field?: string; + /** + * A list of IndexConfigDelta, which describe the intent of this operation. + */ + indexConfigDeltas?: Schema$GoogleFirestoreAdminV1beta2IndexConfigDelta[]; + /** + * The time this operation started. + */ + startTime?: string; + /** + * The state of the operation. + */ + state?: string; + } + /** + * Cloud Firestore indexes enable simple and complex queries against documents + * in a database. + */ + export interface Schema$GoogleFirestoreAdminV1beta2Index { + /** + * The fields supported by this index. For composite indexes, this is + * always 2 or more fields. The last field entry is always for the field + * path `__name__`. If, on creation, `__name__` was not specified as the + * last field, it will be added automatically with the same direction as + * that of the last field defined. If the final field in a composite index + * is not directional, the `__name__` will be ordered ASCENDING (unless + * explicitly specified). For single field indexes, this will always be + * exactly one entry with a field path equal to the field path of the + * associated field. + */ + fields?: Schema$GoogleFirestoreAdminV1beta2IndexField[]; + /** + * Output only. A server defined name for this index. The form of this name + * for composite indexes will be: + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` + * For single field indexes, this field will be empty. + */ + name?: string; + /** + * Indexes with a collection query scope specified allow queries against a + * collection that is the child of a specific document, specified at query + * time, and that has the same collection id. Indexes with a collection + * group query scope specified allow queries against all collections + * descended from a specific document, specified at query time, and that + * have the same collection id as this index. + */ + queryScope?: string; + /** + * Output only. The serving state of the index. + */ + state?: string; + } + /** + * Information about an index configuration change. + */ + export interface Schema$GoogleFirestoreAdminV1beta2IndexConfigDelta { + /** + * Specifies how the index is changing. + */ + changeType?: string; + /** + * The index being changed. + */ + index?: Schema$GoogleFirestoreAdminV1beta2Index; + } + /** + * A field in an index. The field_path describes which field is indexed, the + * value_mode describes how the field value is indexed. + */ + export interface Schema$GoogleFirestoreAdminV1beta2IndexField { + /** + * Indicates that this field supports operations on `array_value`s. + */ + arrayConfig?: string; + /** + * Can be __name__. For single field indexes, this must match the name of + * the field or may be omitted. + */ + fieldPath?: string; + /** + * Indicates that this field supports ordering by the specified order or + * comparing using =, <, <=, >, >=. + */ + order?: string; + } + /** + * Describes the progress of the operation. Unit of work is generic and must + * be interpreted based on where Progress is used. + */ + export interface Schema$GoogleFirestoreAdminV1beta2Progress { + /** + * The amount of work completed. + */ + completedWork?: string; + /** + * The amount of work estimated. + */ + estimatedWork?: string; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string; + } + /** + * A resource that represents Google Cloud Platform location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For + * example, "Tokyo". + */ + displayName?: string; + /** + * Cross-service attributes for the location. For example + * {"cloud.googleapis.com/region": "us-east1"} + */ + labels?: any; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string; + /** + * Service-specific metadata. For example the available capacity at the + * given location. + */ + metadata?: any; + /** + * Resource name for the location, which may vary between implementations. + * For example: `"projects/example-project/locations/us-east1"` + */ + name?: string; + } + + + export class Resource$Projects { + root: Firestore; + locations: Resource$Projects$Locations; + constructor(root: Firestore) { + this.root = root; + this.getRoot.bind(this); + this.locations = new Resource$Projects$Locations(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Locations { + root: Firestore; + constructor(root: Firestore) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * firestore.projects.locations.get + * @desc Gets information about a location. + * @alias firestore.projects.locations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Resource name for the location. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Projects$Locations$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Locations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * firestore.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias firestore.projects.locations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The resource that owns the locations collection, if applicable. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Projects$Locations$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } +} diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index f3b9bd5236d..2682f8e34de 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -419,11 +419,31 @@ export namespace firestore_v1beta1 { * A transformation of a field of the document. */ export interface Schema$FieldTransform { + /** + * Append the given elements in order if they are not already present in the + * current field value. If the field is not an array, or if the field does + * not yet exist, it is first set to the empty array. Equivalent numbers of + * different types (e.g. 3L and 3.0) are considered equal when checking if a + * value is missing. NaN is equal to NaN, and Null is equal to Null. If the + * input contains multiple equivalent values, only the first will be + * considered. The corresponding transform_result will be the null value. + */ + appendMissingElements?: Schema$ArrayValue; /** * The path of the field. See Document.fields for the field path syntax * reference. */ fieldPath?: string; + /** + * Remove all of the given elements from the array in the field. If the + * field is not an array, or if the field does not yet exist, it is set to + * the empty array. Equivalent numbers of the different types (e.g. 3L + * and 3.0) are considered equal when deciding whether an element should be + * removed. NaN is equal to NaN, and Null is equal to Null. This will remove + * all equivalent values if there are duplicates. The corresponding + * transform_result will be the null value. + */ + removeAllFromArray?: Schema$ArrayValue; /** * Sets the field to the given server value. */ @@ -446,10 +466,126 @@ export namespace firestore_v1beta1 { */ unaryFilter?: Schema$UnaryFilter; } + /** + * Metadata for ExportDocuments operations. + */ + export interface Schema$GoogleFirestoreAdminV1beta1ExportDocumentsMetadata { + /** + * Which collection ids are being exported. + */ + collectionIds?: string[]; + /** + * The time the operation ended, either successfully or otherwise. Unset if + * the operation is still active. + */ + endTime?: string; + /** + * The state of the export operation. + */ + operationState?: string; + /** + * Where the entities are being exported to. + */ + outputUriPrefix?: string; + /** + * An estimate of the number of bytes processed. + */ + progressBytes?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * An estimate of the number of documents processed. + */ + progressDocuments?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * The time that work began on the operation. + */ + startTime?: string; + } + /** + * The request for FirestoreAdmin.ExportDocuments. + */ + export interface Schema$GoogleFirestoreAdminV1beta1ExportDocumentsRequest { + /** + * Which collection ids to export. Unspecified means all collections. + */ + collectionIds?: string[]; + /** + * The output URI. Currently only supports Google Cloud Storage URIs of the + * form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the + * name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an + * optional Google Cloud Storage namespace path. When choosing a name, be + * sure to consider Google Cloud Storage naming guidelines: + * https://cloud.google.com/storage/docs/naming. If the URI is a bucket + * (without a namespace path), a prefix will be generated based on the start + * time. + */ + outputUriPrefix?: string; + } + /** + * Returned in the google.longrunning.Operation response field. + */ + export interface Schema$GoogleFirestoreAdminV1beta1ExportDocumentsResponse { + /** + * Location of the output files. This can be used to begin an import into + * Cloud Firestore (this project or another project) after the operation + * completes successfully. + */ + outputUriPrefix?: string; + } + /** + * Metadata for ImportDocuments operations. + */ + export interface Schema$GoogleFirestoreAdminV1beta1ImportDocumentsMetadata { + /** + * Which collection ids are being imported. + */ + collectionIds?: string[]; + /** + * The time the operation ended, either successfully or otherwise. Unset if + * the operation is still active. + */ + endTime?: string; + /** + * The location of the documents being imported. + */ + inputUriPrefix?: string; + /** + * The state of the import operation. + */ + operationState?: string; + /** + * An estimate of the number of bytes processed. + */ + progressBytes?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * An estimate of the number of documents processed. + */ + progressDocuments?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * The time that work began on the operation. + */ + startTime?: string; + } + /** + * The request for FirestoreAdmin.ImportDocuments. + */ + export interface Schema$GoogleFirestoreAdminV1beta1ImportDocumentsRequest { + /** + * Which collection ids to import. Unspecified means all collections + * included in the import. + */ + collectionIds?: string[]; + /** + * Location of the exported files. This must match the output_uri_prefix of + * an ExportDocumentsResponse from an export that has completed + * successfully. See: + * google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix. + */ + inputUriPrefix?: string; + } /** * An index definition. */ - export interface Schema$Index { + export interface Schema$GoogleFirestoreAdminV1beta1Index { /** * The collection ID to which this index applies. Required. */ @@ -457,7 +593,7 @@ export namespace firestore_v1beta1 { /** * The fields to index. */ - fields?: Schema$IndexField[]; + fields?: Schema$GoogleFirestoreAdminV1beta1IndexField[]; /** * The resource name of the index. Output only. */ @@ -470,7 +606,7 @@ export namespace firestore_v1beta1 { /** * A field of an index. */ - export interface Schema$IndexField { + export interface Schema$GoogleFirestoreAdminV1beta1IndexField { /** * The path of the field. Must match the field path specification described * by google.firestore.v1beta1.Document.fields. Special field path @@ -483,6 +619,198 @@ export namespace firestore_v1beta1 { */ mode?: string; } + /** + * The response for FirestoreAdmin.ListIndexes. + */ + export interface Schema$GoogleFirestoreAdminV1beta1ListIndexesResponse { + /** + * The indexes. + */ + indexes?: Schema$GoogleFirestoreAdminV1beta1Index[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string; + } + /** + * The metadata message for google.cloud.location.Location.metadata. + */ + export interface Schema$GoogleFirestoreAdminV1beta1LocationMetadata {} + /** + * Measures the progress of a particular metric. + */ + export interface Schema$GoogleFirestoreAdminV1beta1Progress { + /** + * An estimate of how much work has been completed. Note that this may be + * greater than `work_estimated`. + */ + workCompleted?: string; + /** + * An estimate of how much work needs to be performed. Zero if the work + * estimate is unavailable. May change as work progresses. + */ + workEstimated?: string; + } + /** + * Metadata for google.longrunning.Operation results from + * FirestoreAdmin.UpdateField. + */ + export interface Schema$GoogleFirestoreAdminV1beta2FieldOperationMetadata { + /** + * The progress, in bytes, of this operation. + */ + bytesProgress?: Schema$GoogleFirestoreAdminV1beta2Progress; + /** + * The progress, in documents, of this operation. + */ + documentProgress?: Schema$GoogleFirestoreAdminV1beta2Progress; + /** + * The time this operation completed. Will be unset if operation still in + * progress. + */ + endTime?: string; + /** + * The field resource that this operation is acting on. For example: + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` + */ + field?: string; + /** + * A list of IndexConfigDelta, which describe the intent of this operation. + */ + indexConfigDeltas?: Schema$GoogleFirestoreAdminV1beta2IndexConfigDelta[]; + /** + * The time this operation started. + */ + startTime?: string; + /** + * The state of the operation. + */ + state?: string; + } + /** + * Cloud Firestore indexes enable simple and complex queries against documents + * in a database. + */ + export interface Schema$GoogleFirestoreAdminV1beta2Index { + /** + * The fields supported by this index. For composite indexes, this is + * always 2 or more fields. The last field entry is always for the field + * path `__name__`. If, on creation, `__name__` was not specified as the + * last field, it will be added automatically with the same direction as + * that of the last field defined. If the final field in a composite index + * is not directional, the `__name__` will be ordered ASCENDING (unless + * explicitly specified). For single field indexes, this will always be + * exactly one entry with a field path equal to the field path of the + * associated field. + */ + fields?: Schema$GoogleFirestoreAdminV1beta2IndexField[]; + /** + * Output only. A server defined name for this index. The form of this name + * for composite indexes will be: + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` + * For single field indexes, this field will be empty. + */ + name?: string; + /** + * Indexes with a collection query scope specified allow queries against a + * collection that is the child of a specific document, specified at query + * time, and that has the same collection id. Indexes with a collection + * group query scope specified allow queries against all collections + * descended from a specific document, specified at query time, and that + * have the same collection id as this index. + */ + queryScope?: string; + /** + * Output only. The serving state of the index. + */ + state?: string; + } + /** + * Information about an index configuration change. + */ + export interface Schema$GoogleFirestoreAdminV1beta2IndexConfigDelta { + /** + * Specifies how the index is changing. + */ + changeType?: string; + /** + * The index being changed. + */ + index?: Schema$GoogleFirestoreAdminV1beta2Index; + } + /** + * A field in an index. The field_path describes which field is indexed, the + * value_mode describes how the field value is indexed. + */ + export interface Schema$GoogleFirestoreAdminV1beta2IndexField { + /** + * Indicates that this field supports operations on `array_value`s. + */ + arrayConfig?: string; + /** + * Can be __name__. For single field indexes, this must match the name of + * the field or may be omitted. + */ + fieldPath?: string; + /** + * Indicates that this field supports ordering by the specified order or + * comparing using =, <, <=, >, >=. + */ + order?: string; + } + /** + * Describes the progress of the operation. Unit of work is generic and must + * be interpreted based on where Progress is used. + */ + export interface Schema$GoogleFirestoreAdminV1beta2Progress { + /** + * The amount of work completed. + */ + completedWork?: string; + /** + * The amount of work estimated. + */ + estimatedWork?: string; + } + /** + * This resource represents a long-running operation that is the result of a + * network API call. + */ + export interface Schema$GoogleLongrunningOperation { + /** + * If the value is `false`, it means the operation is still in progress. If + * `true`, the operation is completed, and either `error` or `response` is + * available. + */ + done?: boolean; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically + * contains progress information and common metadata such as create time. + * Some services might not provide such metadata. Any method that returns a + * long-running operation should document the metadata type, if any. + */ + metadata?: any; + /** + * The server-assigned name, which is only unique within the same service + * that originally returns it. If you use the default HTTP mapping, the + * `name` should have the format of `operations/some/unique/name`. + */ + name?: string; + /** + * The normal response of the operation in case of success. If the original + * method returns no data on success, such as `Delete`, the response is + * `google.protobuf.Empty`. If the original method is standard + * `Get`/`Create`/`Update`, the response should be the resource. For other + * methods, the response should have the type `XxxResponse`, where `Xxx` is + * the original method name. For example, if the original method name is + * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: any; + } /** * An object representing a latitude/longitude pair. This is expressed as a * pair of doubles representing degrees latitude and degrees longitude. Unless @@ -584,19 +912,6 @@ export namespace firestore_v1beta1 { */ targetChange?: Schema$TargetChange; } - /** - * The response for FirestoreAdmin.ListIndexes. - */ - export interface Schema$ListIndexesResponse { - /** - * The indexes. - */ - indexes?: Schema$Index[]; - /** - * The standard List next-page token. - */ - nextPageToken?: string; - } /** * A map value. */ @@ -609,45 +924,6 @@ export namespace firestore_v1beta1 { */ fields?: any; } - /** - * This resource represents a long-running operation that is the result of a - * network API call. - */ - export interface Schema$Operation { - /** - * If the value is `false`, it means the operation is still in progress. If - * `true`, the operation is completed, and either `error` or `response` is - * available. - */ - done?: boolean; - /** - * The error result of the operation in case of failure or cancellation. - */ - error?: Schema$Status; - /** - * Service-specific metadata associated with the operation. It typically - * contains progress information and common metadata such as create time. - * Some services might not provide such metadata. Any method that returns a - * long-running operation should document the metadata type, if any. - */ - metadata?: any; - /** - * The server-assigned name, which is only unique within the same service - * that originally returns it. If you use the default HTTP mapping, the - * `name` should have the format of `operations/some/unique/name`. - */ - name?: string; - /** - * The normal response of the operation in case of success. If the original - * method returns no data on success, such as `Delete`, the response is - * `google.protobuf.Empty`. If the original method is standard - * `Get`/`Create`/`Update`, the response should be the resource. For other - * methods, the response should have the type `XxxResponse`, where `Xxx` is - * the original method name. For example, if the original method name is - * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. - */ - response?: any; - } /** * An order on a field. */ @@ -1181,8 +1457,204 @@ export namespace firestore_v1beta1 { getRoot() { return this.root; } + + + /** + * firestore.projects.databases.exportDocuments + * @desc Exports a copy of all or a subset of documents from Google Cloud + * Firestore to another storage system, such as Google Cloud Storage. Recent + * updates to documents may not be reflected in the export. The export + * occurs in the background and its progress can be monitored and managed + * via the Operation resource that is created. The output of an export may + * only be used once the associated operation is done. If an export + * operation is cancelled before completion it may leave partial data behind + * in Google Cloud Storage. + * @alias firestore.projects.databases.exportDocuments + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`. + * @param {().GoogleFirestoreAdminV1beta1ExportDocumentsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + exportDocuments( + params?: Params$Resource$Projects$Databases$Exportdocuments, + options?: MethodOptions): + AxiosPromise; + exportDocuments( + params: Params$Resource$Projects$Databases$Exportdocuments, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + exportDocuments( + params: Params$Resource$Projects$Databases$Exportdocuments, + callback: BodyResponseCallback): + void; + exportDocuments( + callback: BodyResponseCallback): + void; + exportDocuments( + paramsOrCallback?: Params$Resource$Projects$Databases$Exportdocuments| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Exportdocuments; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Databases$Exportdocuments; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:exportDocuments') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * firestore.projects.databases.importDocuments + * @desc Imports documents into Google Cloud Firestore. Existing documents + * with the same name are overwritten. The import occurs in the background + * and its progress can be monitored and managed via the Operation resource + * that is created. If an ImportDocuments operation is cancelled, it is + * possible that a subset of the data has already been imported to Cloud + * Firestore. + * @alias firestore.projects.databases.importDocuments + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`. + * @param {().GoogleFirestoreAdminV1beta1ImportDocumentsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + importDocuments( + params?: Params$Resource$Projects$Databases$Importdocuments, + options?: MethodOptions): + AxiosPromise; + importDocuments( + params: Params$Resource$Projects$Databases$Importdocuments, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + importDocuments( + params: Params$Resource$Projects$Databases$Importdocuments, + callback: BodyResponseCallback): + void; + importDocuments( + callback: BodyResponseCallback): + void; + importDocuments( + paramsOrCallback?: Params$Resource$Projects$Databases$Importdocuments| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Importdocuments; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Databases$Importdocuments; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:importDocuments') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } + export interface Params$Resource$Projects$Databases$Exportdocuments { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Database to export. Should be of the form: + * `projects/{project_id}/databases/{database_id}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirestoreAdminV1beta1ExportDocumentsRequest; + } + export interface Params$Resource$Projects$Databases$Importdocuments { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Database to import into. Should be of the form: + * `projects/{project_id}/databases/{database_id}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirestoreAdminV1beta1ImportDocumentsRequest; + } export class Resource$Projects$Databases$Documents { root: Firestore; @@ -2451,29 +2923,34 @@ export namespace firestore_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.parent The name of the database this index will apply to. For example: `projects/{project_id}/databases/{database_id}` - * @param {().Index} params.resource Request body data + * @param {().GoogleFirestoreAdminV1beta1Index} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create( params?: Params$Resource$Projects$Databases$Indexes$Create, - options?: MethodOptions): AxiosPromise; + options?: MethodOptions): + AxiosPromise; create( params: Params$Resource$Projects$Databases$Indexes$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; create( params: Params$Resource$Projects$Databases$Indexes$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; + callback: BodyResponseCallback): + void; + create(callback: BodyResponseCallback): + void; create( paramsOrCallback?: Params$Resource$Projects$Databases$Indexes$Create| - BodyResponseCallback, + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Projects$Databases$Indexes$Create; let options = (optionsOrCallback || {}) as MethodOptions; @@ -2504,9 +2981,10 @@ export namespace firestore_v1beta1 { context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -2589,18 +3067,28 @@ export namespace firestore_v1beta1 { * @return {object} Request object */ get(params?: Params$Resource$Projects$Databases$Indexes$Get, - options?: MethodOptions): AxiosPromise; + options?: MethodOptions): + AxiosPromise; get(params: Params$Resource$Projects$Databases$Indexes$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; get(params: Params$Resource$Projects$Databases$Indexes$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; + callback: + BodyResponseCallback): + void; + get(callback: + BodyResponseCallback): + void; get(paramsOrCallback?: Params$Resource$Projects$Databases$Indexes$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Projects$Databases$Indexes$Get; let options = (optionsOrCallback || {}) as MethodOptions; @@ -2630,9 +3118,11 @@ export namespace firestore_v1beta1 { context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters); } } @@ -2654,22 +3144,29 @@ export namespace firestore_v1beta1 { */ list( params?: Params$Resource$Projects$Databases$Indexes$List, - options?: MethodOptions): AxiosPromise; + options?: MethodOptions): + AxiosPromise; list( params: Params$Resource$Projects$Databases$Indexes$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; + options: MethodOptions|BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta1ListIndexesResponse>, + callback: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta1ListIndexesResponse>): void; list( params: Params$Resource$Projects$Databases$Indexes$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; + callback: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta1ListIndexesResponse>): void; + list(callback: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta1ListIndexesResponse>): void; list( paramsOrCallback?: Params$Resource$Projects$Databases$Indexes$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta1ListIndexesResponse>, + optionsOrCallback?: MethodOptions|BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta1ListIndexesResponse>, + callback?: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta1ListIndexesResponse>): void| + AxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Projects$Databases$Indexes$List; let options = (optionsOrCallback || {}) as MethodOptions; @@ -2700,9 +3197,11 @@ export namespace firestore_v1beta1 { context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest< + Schema$GoogleFirestoreAdminV1beta1ListIndexesResponse>(parameters); } } } @@ -2722,7 +3221,7 @@ export namespace firestore_v1beta1 { /** * Request body metadata */ - requestBody?: Schema$Index; + requestBody?: Schema$GoogleFirestoreAdminV1beta1Index; } export interface Params$Resource$Projects$Databases$Indexes$Delete { /** diff --git a/src/apis/firestore/v1beta2.ts b/src/apis/firestore/v1beta2.ts new file mode 100644 index 00000000000..16ae9f1c39d --- /dev/null +++ b/src/apis/firestore/v1beta2.ts @@ -0,0 +1,882 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {AxiosPromise} from 'axios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; + +import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from '../../shared/src'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace firestore_v1beta2 { + export interface Options extends GlobalOptions { + version: 'v1beta2'; + } + + /** + * Cloud Firestore API + * + * + * + * @example + * const {google} = require('googleapis'); + * const firestore = google.firestore('v1beta2'); + * + * @namespace firestore + * @type {Function} + * @version v1beta2 + * @variation v1beta2 + * @param {object=} options Options for Firestore + */ + export class Firestore { + _options: GlobalOptions; + google?: GoogleConfigurable; + root = this; + + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.projects = new Resource$Projects(this); + } + + getRoot() { + return this.root; + } + } + + /** + * Metadata for ExportDocuments operations. + */ + export interface Schema$GoogleFirestoreAdminV1beta1ExportDocumentsMetadata { + /** + * Which collection ids are being exported. + */ + collectionIds?: string[]; + /** + * The time the operation ended, either successfully or otherwise. Unset if + * the operation is still active. + */ + endTime?: string; + /** + * The state of the export operation. + */ + operationState?: string; + /** + * Where the entities are being exported to. + */ + outputUriPrefix?: string; + /** + * An estimate of the number of bytes processed. + */ + progressBytes?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * An estimate of the number of documents processed. + */ + progressDocuments?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * The time that work began on the operation. + */ + startTime?: string; + } + /** + * Returned in the google.longrunning.Operation response field. + */ + export interface Schema$GoogleFirestoreAdminV1beta1ExportDocumentsResponse { + /** + * Location of the output files. This can be used to begin an import into + * Cloud Firestore (this project or another project) after the operation + * completes successfully. + */ + outputUriPrefix?: string; + } + /** + * Metadata for ImportDocuments operations. + */ + export interface Schema$GoogleFirestoreAdminV1beta1ImportDocumentsMetadata { + /** + * Which collection ids are being imported. + */ + collectionIds?: string[]; + /** + * The time the operation ended, either successfully or otherwise. Unset if + * the operation is still active. + */ + endTime?: string; + /** + * The location of the documents being imported. + */ + inputUriPrefix?: string; + /** + * The state of the import operation. + */ + operationState?: string; + /** + * An estimate of the number of bytes processed. + */ + progressBytes?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * An estimate of the number of documents processed. + */ + progressDocuments?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * The time that work began on the operation. + */ + startTime?: string; + } + /** + * Metadata for index operations. This metadata populates the metadata field + * of google.longrunning.Operation. + */ + export interface Schema$GoogleFirestoreAdminV1beta1IndexOperationMetadata { + /** + * True if the [google.longrunning.Operation] was cancelled. If the + * cancellation is in progress, cancelled will be true but + * google.longrunning.Operation.done will be false. + */ + cancelled?: boolean; + /** + * Progress of the existing operation, measured in number of documents. + */ + documentProgress?: Schema$GoogleFirestoreAdminV1beta1Progress; + /** + * The time the operation ended, either successfully or otherwise. Unset if + * the operation is still active. + */ + endTime?: string; + /** + * The index resource that this operation is acting on. For example: + * `projects/{project_id}/databases/{database_id}/indexes/{index_id}` + */ + index?: string; + /** + * The type of index operation. + */ + operationType?: string; + /** + * The time that work began on the operation. + */ + startTime?: string; + } + /** + * The metadata message for google.cloud.location.Location.metadata. + */ + export interface Schema$GoogleFirestoreAdminV1beta1LocationMetadata {} + /** + * Measures the progress of a particular metric. + */ + export interface Schema$GoogleFirestoreAdminV1beta1Progress { + /** + * An estimate of how much work has been completed. Note that this may be + * greater than `work_estimated`. + */ + workCompleted?: string; + /** + * An estimate of how much work needs to be performed. Zero if the work + * estimate is unavailable. May change as work progresses. + */ + workEstimated?: string; + } + /** + * Represents a single field in the database. Fields are grouped by their + * "Collection Group", which represent all collections in the + * database with the same id. + */ + export interface Schema$GoogleFirestoreAdminV1beta2Field { + /** + * The index configuration for this field. If unset, field indexing will + * revert to the configuration defined by the `ancestor_field`. To + * explicitly remove all indexes for this field, specify an index config + * with an empty list of indexes. + */ + indexConfig?: Schema$GoogleFirestoreAdminV1beta2IndexConfig; + /** + * A field name of the form + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` + * A field path may be a simple field name, e.g. `address` or a path to + * fields within map_value , e.g. `address.city`, or a special field path. + * The only valid special field is `*`, which represents any field. Field + * paths may be quoted using ` (backtick). The only character that needs to + * be escaped within a quoted field path is the backtick character itself, + * escaped using a backslash. Special characters in field paths that must be + * quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii + * symbolic characters. Examples: (Note: Comments here are written in + * markdown syntax, so there is an additional layer of backticks to + * represent a code block) `\`address.city\`` represents a field named + * `address.city`, not the map key `city` in the field `address`. `\`*\`` + * represents a field named `*`, not any field. A special `Field` contains + * the default indexing settings for all fields. This field's resource + * name is: + * `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x + * Indexes defined on this `Field` will be applied to all fields which do + * not have their own `Field` index configuration. + */ + name?: string; + } + /** + * Metadata for google.longrunning.Operation results from + * FirestoreAdmin.UpdateField. + */ + export interface Schema$GoogleFirestoreAdminV1beta2FieldOperationMetadata { + /** + * The progress, in bytes, of this operation. + */ + bytesProgress?: Schema$GoogleFirestoreAdminV1beta2Progress; + /** + * The progress, in documents, of this operation. + */ + documentProgress?: Schema$GoogleFirestoreAdminV1beta2Progress; + /** + * The time this operation completed. Will be unset if operation still in + * progress. + */ + endTime?: string; + /** + * The field resource that this operation is acting on. For example: + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` + */ + field?: string; + /** + * A list of IndexConfigDelta, which describe the intent of this operation. + */ + indexConfigDeltas?: Schema$GoogleFirestoreAdminV1beta2IndexConfigDelta[]; + /** + * The time this operation started. + */ + startTime?: string; + /** + * The state of the operation. + */ + state?: string; + } + /** + * Cloud Firestore indexes enable simple and complex queries against documents + * in a database. + */ + export interface Schema$GoogleFirestoreAdminV1beta2Index { + /** + * The fields supported by this index. For composite indexes, this is + * always 2 or more fields. The last field entry is always for the field + * path `__name__`. If, on creation, `__name__` was not specified as the + * last field, it will be added automatically with the same direction as + * that of the last field defined. If the final field in a composite index + * is not directional, the `__name__` will be ordered ASCENDING (unless + * explicitly specified). For single field indexes, this will always be + * exactly one entry with a field path equal to the field path of the + * associated field. + */ + fields?: Schema$GoogleFirestoreAdminV1beta2IndexField[]; + /** + * Output only. A server defined name for this index. The form of this name + * for composite indexes will be: + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` + * For single field indexes, this field will be empty. + */ + name?: string; + /** + * Indexes with a collection query scope specified allow queries against a + * collection that is the child of a specific document, specified at query + * time, and that has the same collection id. Indexes with a collection + * group query scope specified allow queries against all collections + * descended from a specific document, specified at query time, and that + * have the same collection id as this index. + */ + queryScope?: string; + /** + * Output only. The serving state of the index. + */ + state?: string; + } + /** + * The index configuration for this field. + */ + export interface Schema$GoogleFirestoreAdminV1beta2IndexConfig { + /** + * Output only. Specifies the resource name of the `Field` from which this + * field's index configuration is set (when `uses_ancestor_config` is + * true), or from which it *would* be set if this field had no index + * configuration (when `uses_ancestor_config` is false). + */ + ancestorField?: string; + /** + * The indexes supported for this field. + */ + indexes?: Schema$GoogleFirestoreAdminV1beta2Index[]; + /** + * Output only When true, the `Field`'s index configuration is in the + * process of being reverted. Once complete, the index config will + * transition to the same state as the field specified by `ancestor_field`, + * at which point `uses_ancestor_config` will be `true` and `reverting` will + * be `false`. + */ + reverting?: boolean; + /** + * Output only. When true, the `Field`'s index configuration is set from + * the configuration specified by the `ancestor_field`. When false, the + * `Field`'s index configuration is defined explicitly. + */ + usesAncestorConfig?: boolean; + } + /** + * Information about an index configuration change. + */ + export interface Schema$GoogleFirestoreAdminV1beta2IndexConfigDelta { + /** + * Specifies how the index is changing. + */ + changeType?: string; + /** + * The index being changed. + */ + index?: Schema$GoogleFirestoreAdminV1beta2Index; + } + /** + * A field in an index. The field_path describes which field is indexed, the + * value_mode describes how the field value is indexed. + */ + export interface Schema$GoogleFirestoreAdminV1beta2IndexField { + /** + * Indicates that this field supports operations on `array_value`s. + */ + arrayConfig?: string; + /** + * Can be __name__. For single field indexes, this must match the name of + * the field or may be omitted. + */ + fieldPath?: string; + /** + * Indicates that this field supports ordering by the specified order or + * comparing using =, <, <=, >, >=. + */ + order?: string; + } + /** + * The response for FirestoreAdmin.ListFields. + */ + export interface Schema$GoogleFirestoreAdminV1beta2ListFieldsResponse { + /** + * The requested fields. + */ + fields?: Schema$GoogleFirestoreAdminV1beta2Field[]; + /** + * A page token that may be used to request another page of results. If + * blank, this is the last page. + */ + nextPageToken?: string; + } + /** + * Describes the progress of the operation. Unit of work is generic and must + * be interpreted based on where Progress is used. + */ + export interface Schema$GoogleFirestoreAdminV1beta2Progress { + /** + * The amount of work completed. + */ + completedWork?: string; + /** + * The amount of work estimated. + */ + estimatedWork?: string; + } + /** + * This resource represents a long-running operation that is the result of a + * network API call. + */ + export interface Schema$GoogleLongrunningOperation { + /** + * If the value is `false`, it means the operation is still in progress. If + * `true`, the operation is completed, and either `error` or `response` is + * available. + */ + done?: boolean; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically + * contains progress information and common metadata such as create time. + * Some services might not provide such metadata. Any method that returns a + * long-running operation should document the metadata type, if any. + */ + metadata?: any; + /** + * The server-assigned name, which is only unique within the same service + * that originally returns it. If you use the default HTTP mapping, the + * `name` should have the format of `operations/some/unique/name`. + */ + name?: string; + /** + * The normal response of the operation in case of success. If the original + * method returns no data on success, such as `Delete`, the response is + * `google.protobuf.Empty`. If the original method is standard + * `Get`/`Create`/`Update`, the response should be the resource. For other + * methods, the response should have the type `XxxResponse`, where `Xxx` is + * the original method name. For example, if the original method name is + * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: any; + } + /** + * The `Status` type defines a logical error model that is suitable for + * different programming environments, including REST APIs and RPC APIs. It is + * used by [gRPC](https://github.com/grpc). The error model is designed to be: + * - Simple to use and understand for most users - Flexible enough to meet + * unexpected needs # Overview The `Status` message contains three pieces of + * data: error code, error message, and error details. The error code should + * be an enum value of google.rpc.Code, but it may accept additional error + * codes if needed. The error message should be a developer-facing English + * message that helps developers *understand* and *resolve* the error. If a + * localized user-facing error message is needed, put the localized message in + * the error details or localize it in the client. The optional error details + * may contain arbitrary information about the error. There is a predefined + * set of error detail types in the package `google.rpc` that can be used for + * common error conditions. # Language mapping The `Status` message is the + * logical representation of the error model, but it is not necessarily the + * actual wire format. When the `Status` message is exposed in different + * client libraries and different wire protocols, it can be mapped + * differently. For example, it will likely be mapped to some exceptions in + * Java, but more likely mapped to some error codes in C. # Other uses The + * error model and the `Status` message can be used in a variety of + * environments, either with or without APIs, to provide a consistent + * developer experience across different environments. Example uses of this + * error model include: - Partial errors. If a service needs to return + * partial errors to the client, it may embed the `Status` in the normal + * response to indicate the partial errors. - Workflow errors. A typical + * workflow has multiple steps. Each step may have a `Status` message for + * error reporting. - Batch operations. If a client uses batch request and + * batch response, the `Status` message should be used directly inside + * batch response, one for each error sub-response. - Asynchronous + * operations. If an API call embeds asynchronous operation results in its + * response, the status of those operations should be represented directly + * using the `Status` message. - Logging. If some API errors are stored in + * logs, the message `Status` could be used directly after any stripping + * needed for security/privacy reasons. + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number; + /** + * A list of messages that carry the error details. There is a common set + * of message types for APIs to use. + */ + details?: any[]; + /** + * A developer-facing error message, which should be in English. Any + * user-facing error message should be localized and sent in the + * google.rpc.Status.details field, or localized by the client. + */ + message?: string; + } + + + export class Resource$Projects { + root: Firestore; + databases: Resource$Projects$Databases; + constructor(root: Firestore) { + this.root = root; + this.getRoot.bind(this); + this.databases = new Resource$Projects$Databases(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Databases { + root: Firestore; + collectionGroups: Resource$Projects$Databases$Collectiongroups; + constructor(root: Firestore) { + this.root = root; + this.getRoot.bind(this); + this.collectionGroups = + new Resource$Projects$Databases$Collectiongroups(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Databases$Collectiongroups { + root: Firestore; + fields: Resource$Projects$Databases$Collectiongroups$Fields; + constructor(root: Firestore) { + this.root = root; + this.getRoot.bind(this); + this.fields = + new Resource$Projects$Databases$Collectiongroups$Fields(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Databases$Collectiongroups$Fields { + root: Firestore; + constructor(root: Firestore) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * firestore.projects.databases.collectionGroups.fields.get + * @desc Gets the metadata and configuration for a Field. + * @alias firestore.projects.databases.collectionGroups.fields.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name A name of the form `/projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + options?: MethodOptions): + AxiosPromise; + get(params: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + get(params: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + callback: + BodyResponseCallback): + void; + get(callback: + BodyResponseCallback): + void; + get(paramsOrCallback?: + Params$Resource$Projects$Databases$Collectiongroups$Fields$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Collectiongroups$Fields$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Databases$Collectiongroups$Fields$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * firestore.projects.databases.collectionGroups.fields.list + * @desc Lists the field configuration and metadata for this database. + * Currently, FirestoreAdmin.ListFields only supports listing fields that + * have been explicitly overridden. To issue this query, call + * FirestoreAdmin.ListFields with the filter set to + * `indexConfig.usesAncestorConfig:false`. + * @alias firestore.projects.databases.collectionGroups.fields.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`. + * @param {integer=} params.pageSize The number of results to return. + * @param {string=} params.pageToken A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results. + * @param {string} params.parent A parent name of the form `/projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: + Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + options: MethodOptions|BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta2ListFieldsResponse>, + callback: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta2ListFieldsResponse>): void; + list( + params: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + callback: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta2ListFieldsResponse>): void; + list(callback: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta2ListFieldsResponse>): void; + list( + paramsOrCallback?: + Params$Resource$Projects$Databases$Collectiongroups$Fields$List| + BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta2ListFieldsResponse>, + optionsOrCallback?: MethodOptions|BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta2ListFieldsResponse>, + callback?: BodyResponseCallback< + Schema$GoogleFirestoreAdminV1beta2ListFieldsResponse>): void| + AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Collectiongroups$Fields$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Databases$Collectiongroups$Fields$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+parent}/fields') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleFirestoreAdminV1beta2ListFieldsResponse>(parameters); + } + } + + + /** + * firestore.projects.databases.collectionGroups.fields.patch + * @desc Updates a field configuration. Currently, field updates apply only + * to single field index configuration. However, calls to + * FirestoreAdmin.UpdateField should provide a field mask to avoid changing + * any configuration that the caller isn't aware of. The field mask should + * be specified as: `{ paths: "index_config" }`. This call returns a + * google.longrunning.Operation which may be used to track the status of the + * field update. The metadata for the operation will be the type + * FieldOperationMetadata. To configure the default field settings for the + * database, use the special `Field` with resource name: + * `/projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x`. + * @alias firestore.projects.databases.collectionGroups.fields.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. + * @param {string=} params.updateMask A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field. + * @param {().GoogleFirestoreAdminV1beta2Field} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: + Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch, + options?: MethodOptions): + AxiosPromise; + patch( + params: + Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + patch( + params: + Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch, + callback: BodyResponseCallback): + void; + patch(callback: BodyResponseCallback): + void; + patch( + paramsOrCallback?: + Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Databases$Collectiongroups$Fields$Get { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A name of the form + * `/projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}` + */ + name?: string; + } + export interface Params$Resource$Projects$Databases$Collectiongroups$Fields$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The filter to apply to list results. Currently, FirestoreAdmin.ListFields + * only supports listing fields that have been explicitly overridden. To + * issue this query, call FirestoreAdmin.ListFields with the filter set to + * `indexConfig.usesAncestorConfig:false`. + */ + filter?: string; + /** + * The number of results to return. + */ + pageSize?: number; + /** + * A page token, returned from a previous call to FirestoreAdmin.ListFields, + * that may be used to get the next page of results. + */ + pageToken?: string; + /** + * A parent name of the form + * `/projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Databases$Collectiongroups$Fields$Patch { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A field name of the form + * `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` + * A field path may be a simple field name, e.g. `address` or a path to + * fields within map_value , e.g. `address.city`, or a special field path. + * The only valid special field is `*`, which represents any field. Field + * paths may be quoted using ` (backtick). The only character that needs to + * be escaped within a quoted field path is the backtick character itself, + * escaped using a backslash. Special characters in field paths that must be + * quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii + * symbolic characters. Examples: (Note: Comments here are written in + * markdown syntax, so there is an additional layer of backticks to + * represent a code block) `\`address.city\`` represents a field named + * `address.city`, not the map key `city` in the field `address`. `\`*\`` + * represents a field named `*`, not any field. A special `Field` contains + * the default indexing settings for all fields. This field's resource name + * is: + * `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/x` + * Indexes defined on this `Field` will be applied to all fields which do + * not have their own `Field` index configuration. + */ + name?: string; + /** + * A mask, relative to the field. If specified, only configuration specified + * by this field_mask will be updated in the field. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirestoreAdminV1beta2Field; + } +} diff --git a/src/apis/genomics/v1.ts b/src/apis/genomics/v1.ts index 08fc1713584..d67c5ea6e94 100644 --- a/src/apis/genomics/v1.ts +++ b/src/apis/genomics/v1.ts @@ -224,6 +224,13 @@ export namespace genomics_v1 { * Associates `members` with a `role`. */ export interface Schema$Binding { + /** + * Unimplemented. The condition that is associated with this binding. NOTE: + * an unsatisfied condition will not allow user access via current binding. + * Different bindings, including their conditions, are examined + * independently. + */ + condition?: Schema$Expr; /** * Specifies the identities requesting access for a Cloud Platform resource. * `members` can have the following values: * `allUsers`: A special @@ -242,7 +249,7 @@ export namespace genomics_v1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } @@ -356,6 +363,17 @@ export namespace genomics_v1 { */ zone?: string; } + /** + * This event is generated when a container is forcibly terminated by the + * worker. Currently, this only occurs when the container outlives the user + * specified timeout. + */ + export interface Schema$ContainerKilledEvent { + /** + * The numeric ID of the action that started the container. + */ + actionId?: number; + } /** * This event is generated when a container starts. */ @@ -597,6 +615,35 @@ export namespace genomics_v1 { */ projectId?: string; } + /** + * Represents an expression text. Example: title: "User account + * presence" description: "Determines whether the request has a + * user account" expression: "size(request.user) > 0" + */ + export interface Schema$Expr { + /** + * An optional description of the expression. This is a longer text which + * describes the expression, e.g. when hovered over it in a UI. + */ + description?: string; + /** + * Textual representation of an expression in Common Expression Language + * syntax. The application context of the containing message determines + * which well-known feature set of CEL is supported. + */ + expression?: string; + /** + * An optional string indicating the location of the expression for error + * reporting, e.g. a file name and a position in the file. + */ + location?: string; + /** + * An optional title for the expression, i.e. a short string describing its + * purpose. This can be used e.g. in UIs which allow to enter the + * expression. + */ + title?: string; + } export interface Schema$ExternalId { /** * The id used by the source of this data. diff --git a/src/apis/genomics/v1alpha2.ts b/src/apis/genomics/v1alpha2.ts index 37759c674e1..ac923874d77 100644 --- a/src/apis/genomics/v1alpha2.ts +++ b/src/apis/genomics/v1alpha2.ts @@ -93,6 +93,17 @@ export namespace genomics_v1alpha2 { */ zone?: string; } + /** + * This event is generated when a container is forcibly terminated by the + * worker. Currently, this only occurs when the container outlives the user + * specified timeout. + */ + export interface Schema$ContainerKilledEvent { + /** + * The numeric ID of the action that started the container. + */ + actionId?: number; + } /** * This event is generated when a container starts. */ diff --git a/src/apis/genomics/v2alpha1.ts b/src/apis/genomics/v2alpha1.ts index 9b6e2ff1081..198e60eb845 100644 --- a/src/apis/genomics/v2alpha1.ts +++ b/src/apis/genomics/v2alpha1.ts @@ -182,6 +182,13 @@ export namespace genomics_v2alpha1 { * ContainerStartedEvent in the operation metadata. */ portMappings?: any; + /** + * The maximum amount of time to give the action to complete. If the action + * fails to complete before the timeout, it will be terminated and the exit + * status will be non-zero. The pipeline will continue or terminate based + * on the rules defined by the ALWAYS_RUN and IGNORE_EXIT_STATUS flags. + */ + timeout?: string; } /** * The request message for Operations.CancelOperation. @@ -242,6 +249,17 @@ export namespace genomics_v2alpha1 { */ zone?: string; } + /** + * This event is generated when a container is forcibly terminated by the + * worker. Currently, this only occurs when the container outlives the user + * specified timeout. + */ + export interface Schema$ContainerKilledEvent { + /** + * The numeric ID of the action that started the container. + */ + actionId?: number; + } /** * This event is generated when a container starts. */ @@ -307,7 +325,9 @@ export namespace genomics_v2alpha1 { metrics?: string[]; } /** - * Carries information about a disk that can be attached to a VM. + * Carries information about a disk that can be attached to a VM. See + * https://cloud.google.com/compute/docs/disks/performance for more + * information about disk type, size and performance considerations. */ export interface Schema$Disk { /** @@ -317,10 +337,12 @@ export namespace genomics_v2alpha1 { */ name?: string; /** - * The size, in gigabytes, of the disk to attach. Note that this value is - * not configurable for some disk types such as local-ssd. If the size is - * not specified, a size of at least 500gb is used to ensure reasonable I/O - * performance. + * The size, in gigabytes, of the disk to attach. If the size is not + * specified, a default is chosen to ensure reasonable I/O performance. If + * the disk type is specified as `local-ssd`, multiple local drives are + * automatically combined to provide the requested size. Note, however, + * that each physical SSD is 375GB in size, and no more than 8 drives can be + * attached to a single instance. */ sizeGb?: number; /** @@ -328,7 +350,7 @@ export namespace genomics_v2alpha1 { */ sourceImage?: string; /** - * The Compute Engine disk type. If unspecified, 'standard-pd' is + * The Compute Engine disk type. If unspecified, 'pd-standard' is * used. */ type?: string; diff --git a/src/apis/groupssettings/v1.ts b/src/apis/groupssettings/v1.ts index 9d3e3a045c2..c7a6a51236e 100644 --- a/src/apis/groupssettings/v1.ts +++ b/src/apis/groupssettings/v1.ts @@ -105,6 +105,10 @@ export namespace groupssettings_v1 { * Email id of the group */ email?: string; + /** + * If favorite replies should be displayed above other replies. + */ + favoriteRepliesOnTop?: string; /** * Whether to include custom footer. */ @@ -171,12 +175,27 @@ export namespace groupssettings_v1 { * ALL_OWNERS_CAN_ADD ALL_MEMBERS_CAN_ADD NONE_CAN_ADD */ whoCanAdd?: string; + /** + * Permission to add references to a topic. Possible values are: NONE + * OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + */ + whoCanAddReferences?: string; + /** + * Permission to assign topics in a forum to another user. Possible values + * are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + */ + whoCanAssignTopics?: string; /** * Permission to contact owner of the group via web UI. Possible values are: * ANYONE_CAN_CONTACT ALL_IN_DOMAIN_CAN_CONTACT ALL_MEMBERS_CAN_CONTACT * ALL_MANAGERS_CAN_CONTACT */ whoCanContactOwner?: string; + /** + * Permission to enter free form tags for topics in a forum. Possible values + * are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + */ + whoCanEnterFreeFormTags?: string; /** * Permissions to invite members. Possible values are: * ALL_MEMBERS_CAN_INVITE ALL_MANAGERS_CAN_INVITE ALL_OWNERS_CAN_INVITE @@ -194,12 +213,55 @@ export namespace groupssettings_v1 { * NONE_CAN_LEAVE */ whoCanLeaveGroup?: string; + /** + * Permission to mark a topic as a duplicate of another topic. Possible + * values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS + * ALL_MEMBERS + */ + whoCanMarkDuplicate?: string; + /** + * Permission to mark any other user's post as a favorite reply. + * Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS + * ALL_MEMBERS + */ + whoCanMarkFavoriteReplyOnAnyTopic?: string; + /** + * Permission to mark a post for a topic they started as a favorite reply. + * Possible values are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS + * ALL_MEMBERS + */ + whoCanMarkFavoriteReplyOnOwnTopic?: string; + /** + * Permission to mark a topic as not needing a response. Possible values + * are: NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + */ + whoCanMarkNoResponseNeeded?: string; + /** + * Permission to change tags and categories. Possible values are: NONE + * OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + */ + whoCanModifyTagsAndCategories?: string; /** * Permissions to post messages to the group. Possible values are: * NONE_CAN_POST ALL_MANAGERS_CAN_POST ALL_MEMBERS_CAN_POST * ALL_OWNERS_CAN_POST ALL_IN_DOMAIN_CAN_POST ANYONE_CAN_POST */ whoCanPostMessage?: string; + /** + * Permission to take topics in a forum. Possible values are: NONE + * OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + */ + whoCanTakeTopics?: string; + /** + * Permission to unassign any topic in a forum. Possible values are: NONE + * OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + */ + whoCanUnassignTopic?: string; + /** + * Permission to unmark any post from a favorite reply. Possible values are: + * NONE OWNERS_ONLY MANAGERS_ONLY OWNERS_AND_MANAGERS ALL_MEMBERS + */ + whoCanUnmarkFavoriteReplyOnAnyTopic?: string; /** * Permissions to view group. Possible values are: ANYONE_CAN_VIEW * ALL_IN_DOMAIN_CAN_VIEW ALL_MEMBERS_CAN_VIEW ALL_MANAGERS_CAN_VIEW diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index 9d3fb33026c..7db93a43c29 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -172,7 +172,7 @@ export namespace iam_v1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } diff --git a/src/apis/iamcredentials/v1.ts b/src/apis/iamcredentials/v1.ts index d3fea745858..351617a74a2 100644 --- a/src/apis/iamcredentials/v1.ts +++ b/src/apis/iamcredentials/v1.ts @@ -50,15 +50,528 @@ export namespace iamcredentials_v1 { google?: GoogleConfigurable; root = this; + projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this._options = options || {}; this.google = google; this.getRoot.bind(this); + + this.projects = new Resource$Projects(this); } getRoot() { return this.root; } } + + export interface Schema$GenerateAccessTokenRequest { + /** + * The sequence of service accounts in a delegation chain. Each service + * account must be granted the `roles/iam.serviceAccountTokenCreator` role + * on its next service account in the chain. The last service account in the + * chain must be granted the `roles/iam.serviceAccountTokenCreator` role on + * the service account that is specified in the `name` field of the request. + * The delegates must have the following format: + * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}` + */ + delegates?: string[]; + /** + * The desired lifetime duration of the access token in seconds. Must be set + * to a value less than or equal to 3600 (1 hour). If a value is not + * specified, the token's lifetime will be set to a default value of one + * hour. + */ + lifetime?: string; + /** + * Code to identify ApiScope (OAuth scope to be precise) to be included in + * the OAuth token. See + * https://developers.google.com/identity/protocols/googlescopes for more + * information. At least one value required. + */ + scope?: string[]; + } + export interface Schema$GenerateAccessTokenResponse { + /** + * The OAuth 2.0 access token. + */ + accessToken?: string; + /** + * Token expiration time. + */ + expireTime?: string; + } + export interface Schema$GenerateIdTokenRequest { + /** + * The audience for the token, such as the API or account that this token + * grants access to. + */ + audience?: string; + /** + * The sequence of service accounts in a delegation chain. Each service + * account must be granted the `roles/iam.serviceAccountTokenCreator` role + * on its next service account in the chain. The last service account in the + * chain must be granted the `roles/iam.serviceAccountTokenCreator` role on + * the service account that is specified in the `name` field of the request. + * The delegates must have the following format: + * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}` + */ + delegates?: string[]; + /** + * Include the service account email in the token. If set to `true`, the + * token will contain `email` and `email_verified` claims. + */ + includeEmail?: boolean; + } + export interface Schema$GenerateIdTokenResponse { + /** + * The OpenId Connect ID token. + */ + token?: string; + } + export interface Schema$SignBlobRequest { + /** + * The sequence of service accounts in a delegation chain. Each service + * account must be granted the `roles/iam.serviceAccountTokenCreator` role + * on its next service account in the chain. The last service account in the + * chain must be granted the `roles/iam.serviceAccountTokenCreator` role on + * the service account that is specified in the `name` field of the request. + * The delegates must have the following format: + * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}` + */ + delegates?: string[]; + /** + * The bytes to sign. + */ + payload?: string; + } + export interface Schema$SignBlobResponse { + /** + * The ID of the key used to sign the blob. + */ + keyId?: string; + /** + * The signed blob. + */ + signedBlob?: string; + } + export interface Schema$SignJwtRequest { + /** + * The sequence of service accounts in a delegation chain. Each service + * account must be granted the `roles/iam.serviceAccountTokenCreator` role + * on its next service account in the chain. The last service account in the + * chain must be granted the `roles/iam.serviceAccountTokenCreator` role on + * the service account that is specified in the `name` field of the request. + * The delegates must have the following format: + * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}` + */ + delegates?: string[]; + /** + * The JWT payload to sign: a JSON object that contains a JWT Claims Set. + */ + payload?: string; + } + export interface Schema$SignJwtResponse { + /** + * The ID of the key used to sign the JWT. + */ + keyId?: string; + /** + * The signed JWT. + */ + signedJwt?: string; + } + + + export class Resource$Projects { + root: Iamcredentials; + serviceAccounts: Resource$Projects$Serviceaccounts; + constructor(root: Iamcredentials) { + this.root = root; + this.getRoot.bind(this); + this.serviceAccounts = new Resource$Projects$Serviceaccounts(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Serviceaccounts { + root: Iamcredentials; + constructor(root: Iamcredentials) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * iamcredentials.projects.serviceAccounts.generateAccessToken + * @desc Generates an OAuth 2.0 access token for a service account. + * @alias iamcredentials.projects.serviceAccounts.generateAccessToken + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. Using `-` as a wildcard for the project will infer the project from the account. + * @param {().GenerateAccessTokenRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + generateAccessToken( + params?: Params$Resource$Projects$Serviceaccounts$Generateaccesstoken, + options?: MethodOptions): + AxiosPromise; + generateAccessToken( + params: Params$Resource$Projects$Serviceaccounts$Generateaccesstoken, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + generateAccessToken( + params: Params$Resource$Projects$Serviceaccounts$Generateaccesstoken, + callback: BodyResponseCallback): + void; + generateAccessToken( + callback: BodyResponseCallback): + void; + generateAccessToken( + paramsOrCallback?: + Params$Resource$Projects$Serviceaccounts$Generateaccesstoken| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Serviceaccounts$Generateaccesstoken; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Serviceaccounts$Generateaccesstoken; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://iamcredentials.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:generateAccessToken') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * iamcredentials.projects.serviceAccounts.generateIdToken + * @desc Generates an OpenID Connect ID token for a service account. + * @alias iamcredentials.projects.serviceAccounts.generateIdToken + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. Using `-` as a wildcard for the project will infer the project from the account. + * @param {().GenerateIdTokenRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + generateIdToken( + params?: Params$Resource$Projects$Serviceaccounts$Generateidtoken, + options?: MethodOptions): AxiosPromise; + generateIdToken( + params: Params$Resource$Projects$Serviceaccounts$Generateidtoken, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + generateIdToken( + params: Params$Resource$Projects$Serviceaccounts$Generateidtoken, + callback: BodyResponseCallback): void; + generateIdToken( + callback: BodyResponseCallback): void; + generateIdToken( + paramsOrCallback?: + Params$Resource$Projects$Serviceaccounts$Generateidtoken| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Serviceaccounts$Generateidtoken; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Serviceaccounts$Generateidtoken; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://iamcredentials.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:generateIdToken') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * iamcredentials.projects.serviceAccounts.signBlob + * @desc Signs a blob using a service account's system-managed private key. + * @alias iamcredentials.projects.serviceAccounts.signBlob + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. Using `-` as a wildcard for the project will infer the project from the account. + * @param {().SignBlobRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + signBlob( + params?: Params$Resource$Projects$Serviceaccounts$Signblob, + options?: MethodOptions): AxiosPromise; + signBlob( + params: Params$Resource$Projects$Serviceaccounts$Signblob, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + signBlob( + params: Params$Resource$Projects$Serviceaccounts$Signblob, + callback: BodyResponseCallback): void; + signBlob(callback: BodyResponseCallback): void; + signBlob( + paramsOrCallback?: Params$Resource$Projects$Serviceaccounts$Signblob| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Serviceaccounts$Signblob; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Serviceaccounts$Signblob; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://iamcredentials.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:signBlob') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * iamcredentials.projects.serviceAccounts.signJwt + * @desc Signs a JWT using a service account's system-managed private key. + * @alias iamcredentials.projects.serviceAccounts.signJwt + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the service account for which the credentials are requested, in the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. Using `-` as a wildcard for the project will infer the project from the account. + * @param {().SignJwtRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + signJwt( + params?: Params$Resource$Projects$Serviceaccounts$Signjwt, + options?: MethodOptions): AxiosPromise; + signJwt( + params: Params$Resource$Projects$Serviceaccounts$Signjwt, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + signJwt( + params: Params$Resource$Projects$Serviceaccounts$Signjwt, + callback: BodyResponseCallback): void; + signJwt(callback: BodyResponseCallback): void; + signJwt( + paramsOrCallback?: Params$Resource$Projects$Serviceaccounts$Signjwt| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Serviceaccounts$Signjwt; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Serviceaccounts$Signjwt; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://iamcredentials.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:signJwt') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Serviceaccounts$Generateaccesstoken { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the service account for which the credentials are + * requested, in the following format: + * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. Using `-` as a + * wildcard for the project will infer the project from the account. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateAccessTokenRequest; + } + export interface Params$Resource$Projects$Serviceaccounts$Generateidtoken { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the service account for which the credentials are + * requested, in the following format: + * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. Using `-` as a + * wildcard for the project will infer the project from the account. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateIdTokenRequest; + } + export interface Params$Resource$Projects$Serviceaccounts$Signblob { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the service account for which the credentials are + * requested, in the following format: + * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. Using `-` as a + * wildcard for the project will infer the project from the account. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SignBlobRequest; + } + export interface Params$Resource$Projects$Serviceaccounts$Signjwt { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the service account for which the credentials are + * requested, in the following format: + * `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. Using `-` as a + * wildcard for the project will infer the project from the account. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SignJwtRequest; + } } diff --git a/src/apis/iap/README.md b/src/apis/iap/README.md new file mode 100644 index 00000000000..46d22adb471 --- /dev/null +++ b/src/apis/iap/README.md @@ -0,0 +1,27 @@ +Google Inc. logo + +# @google/iap + +> Controls access to cloud applications running on Google Cloud Platform. + +## Installation + +```sh +$ npm install @google/iap +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/google/google-api-nodejs-client). + +## License +This library is licensed under Apache 2.0. Full license text is available in [COPYING](https://github.com/google/google-api-nodejs-client/blob/master/COPYING). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/master/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/google/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/iap/index.ts b/src/apis/iap/index.ts new file mode 100644 index 00000000000..10e7d8a812d --- /dev/null +++ b/src/apis/iap/index.ts @@ -0,0 +1,28 @@ +// Copyright 2018, Google, LLC. +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {getAPI, GoogleConfigurable} from '../../shared/src'; +import {iap_v1beta1} from './v1beta1'; + +export const VERSIONS = { + 'v1beta1': iap_v1beta1.Iap, +}; + +export function iap(version: 'v1beta1'): iap_v1beta1.Iap; +export function iap(options: iap_v1beta1.Options): iap_v1beta1.Iap; +export function iap( + this: GoogleConfigurable, versionOrOptions: 'v1beta1'|iap_v1beta1.Options) { + return getAPI('iap', versionOrOptions, VERSIONS, this); +} diff --git a/src/apis/iap/package.json b/src/apis/iap/package.json new file mode 100644 index 00000000000..1d0495127f4 --- /dev/null +++ b/src/apis/iap/package.json @@ -0,0 +1,24 @@ +{ + "name": "@google/iap", + "version": "0.1.0", + "description": "iap", + "main": "index.js", + "types": "index.d.ts", + "keywords": ["google"], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/google/google-api-nodejs-client", + "bugs": { + "url" : "https://github.com/google/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url" : "https://github.com/google/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=6.0.0" + }, + "dependencies": { + "googleapis-common": "^0.1.0" + } +} diff --git a/src/apis/iap/v1beta1.ts b/src/apis/iap/v1beta1.ts new file mode 100644 index 00000000000..6c48974d562 --- /dev/null +++ b/src/apis/iap/v1beta1.ts @@ -0,0 +1,1324 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {AxiosPromise} from 'axios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; + +import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from '../../shared/src'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace iap_v1beta1 { + export interface Options extends GlobalOptions { + version: 'v1beta1'; + } + + /** + * Cloud Identity-Aware Proxy API + * + * Controls access to cloud applications running on Google Cloud Platform. + * + * @example + * const {google} = require('googleapis'); + * const iap = google.iap('v1beta1'); + * + * @namespace iap + * @type {Function} + * @version v1beta1 + * @variation v1beta1 + * @param {object=} options Options for Iap + */ + export class Iap { + _options: GlobalOptions; + google?: GoogleConfigurable; + root = this; + + oauth: Resource$Oauth; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.oauth = new Resource$Oauth(this); + this.projects = new Resource$Projects(this); + } + + getRoot() { + return this.root; + } + } + + /** + * Specifies the audit configuration for a service. The configuration + * determines which permission types are logged, and what identities, if any, + * are exempted from logging. An AuditConfig must have one or more + * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + * specific service, the union of the two AuditConfigs is used for that + * service: the log_types specified in each AuditConfig are enabled, and the + * exempted_members in each AuditLogConfig are exempted. Example Policy with + * multiple AuditConfigs: { "audit_configs": [ { + * "service": "allServices" "audit_log_configs": + * [ { "log_type": "DATA_READ", + * "exempted_members": [ "user:foo@gmail.com" ] }, { + * "log_type": "DATA_WRITE", }, { + * "log_type": "ADMIN_READ", } ] }, + * { "service": "fooservice.googleapis.com" + * "audit_log_configs": [ { "log_type": + * "DATA_READ", }, { "log_type": + * "DATA_WRITE", "exempted_members": [ + * "user:bar@gmail.com" ] } ] } + * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and + * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, + * and bar@gmail.com from DATA_WRITE logging. + */ + export interface Schema$AuditConfig { + /** + * The configuration for logging of each type of permission. + */ + auditLogConfigs?: Schema$AuditLogConfig[]; + /** + * Specifies a service that will be enabled for audit logging. For example, + * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a + * special value that covers all services. + */ + service?: string; + } + /** + * Provides the configuration for logging a type of permissions. Example: { + * "audit_log_configs": [ { "log_type": + * "DATA_READ", "exempted_members": [ + * "user:foo@gmail.com" ] }, { + * "log_type": "DATA_WRITE", } ] } This + * enables 'DATA_READ' and 'DATA_WRITE' logging, while + * exempting foo@gmail.com from DATA_READ logging. + */ + export interface Schema$AuditLogConfig { + /** + * Specifies the identities that do not cause logging for this type of + * permission. Follows the same format of Binding.members. + */ + exemptedMembers?: string[]; + /** + * The log type that this config enables. + */ + logType?: string; + } + /** + * Associates `members` with a `role`. + */ + export interface Schema$Binding { + /** + * Unimplemented. The condition that is associated with this binding. NOTE: + * an unsatisfied condition will not allow user access via current binding. + * Different bindings, including their conditions, are examined + * independently. + */ + condition?: Schema$Expr; + /** + * Specifies the identities requesting access for a Cloud Platform resource. + * `members` can have the following values: * `allUsers`: A special + * identifier that represents anyone who is on the internet; with or + * without a Google account. * `allAuthenticatedUsers`: A special + * identifier that represents anyone who is authenticated with a Google + * account or a service account. * `user:{emailid}`: An email address that + * represents a specific Google account. For example, `alice@gmail.com` . + * * `serviceAccount:{emailid}`: An email address that represents a service + * account. For example, `my-other-app@appspot.gserviceaccount.com`. * + * `group:{emailid}`: An email address that represents a Google group. For + * example, `admins@example.com`. * `domain:{domain}`: A Google Apps + * domain name that represents all the users of that domain. For example, + * `google.com` or `example.com`. + */ + members?: string[]; + /** + * Role that is assigned to `members`. For example, `roles/viewer`, + * `roles/editor`, or `roles/owner`. + */ + role?: string; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated + * empty messages in your APIs. A typical example is to use it as the request + * or the response type of an API method. For instance: service Foo { rpc + * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON + * representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} + /** + * Represents an expression text. Example: title: "User account + * presence" description: "Determines whether the request has a + * user account" expression: "size(request.user) > 0" + */ + export interface Schema$Expr { + /** + * An optional description of the expression. This is a longer text which + * describes the expression, e.g. when hovered over it in a UI. + */ + description?: string; + /** + * Textual representation of an expression in Common Expression Language + * syntax. The application context of the containing message determines + * which well-known feature set of CEL is supported. + */ + expression?: string; + /** + * An optional string indicating the location of the expression for error + * reporting, e.g. a file name and a position in the file. + */ + location?: string; + /** + * An optional title for the expression, i.e. a short string describing its + * purpose. This can be used e.g. in UIs which allow to enter the + * expression. + */ + title?: string; + } + /** + * Request message for `GetIamPolicy` method. + */ + export interface Schema$GetIamPolicyRequest {} + /** + * Defines an Identity and Access Management (IAM) policy. It is used to + * specify access control policies for Cloud Platform resources. A `Policy` + * consists of a list of `bindings`. A `binding` binds a list of `members` to + * a `role`, where the members can be user accounts, Google groups, Google + * domains, and service accounts. A `role` is a named list of permissions + * defined by IAM. **JSON Example** { "bindings": [ { + * "role": "roles/owner", "members": [ + * "user:mike@example.com", "group:admins@example.com", + * "domain:google.com", + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { + * "role": "roles/viewer", "members": + * ["user:sean@example.com"] } ] } **YAML + * Example** bindings: - members: - user:mike@example.com - + * group:admins@example.com - domain:google.com - + * serviceAccount:my-other-app@appspot.gserviceaccount.com role: + * roles/owner - members: - user:sean@example.com role: + * roles/viewer For a description of IAM and its features, see the [IAM + * developer's guide](https://cloud.google.com/iam/docs). + */ + export interface Schema$Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$AuditConfig[]; + /** + * Associates a list of `members` to a `role`. `bindings` with no members + * will result in an error. + */ + bindings?: Schema$Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help + * prevent simultaneous updates of a policy from overwriting each other. It + * is strongly suggested that systems make use of the `etag` in the + * read-modify-write cycle to perform policy updates in order to avoid race + * conditions: An `etag` is returned in the response to `getIamPolicy`, and + * systems are expected to put that etag in the request to `setIamPolicy` to + * ensure that their change will be applied to the same version of the + * policy. If no `etag` is provided in the call to `setIamPolicy`, then the + * existing policy is overwritten blindly. + */ + etag?: string; + /** + * Deprecated. + */ + version?: number; + } + /** + * Request message for `SetIamPolicy` method. + */ + export interface Schema$SetIamPolicyRequest { + /** + * REQUIRED: The complete policy to be applied to the `resource`. The size + * of the policy is limited to a few 10s of KB. An empty policy is a valid + * policy but certain Cloud Platform services (such as Projects) might + * reject them. + */ + policy?: Schema$Policy; + /** + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. + * Only the fields in the mask will be modified. If no mask is provided, the + * following default mask is used: paths: "bindings, etag" This + * field is only used by Cloud IAM. + */ + updateMask?: string; + } + /** + * Request message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsRequest { + /** + * The set of permissions to check for the `resource`. Permissions with + * wildcards (such as '*' or 'storage.*') are not allowed. + * For more information see [IAM + * Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is + * allowed. + */ + permissions?: string[]; + } + + + export class Resource$Oauth { + root: Iap; + clientIds: Resource$Oauth$Clientids; + constructor(root: Iap) { + this.root = root; + this.getRoot.bind(this); + this.clientIds = new Resource$Oauth$Clientids(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Oauth$Clientids { + root: Iap; + constructor(root: Iap) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * iap.oauth.clientIds.handleRedirect + * @desc This endpoint is only meant to serve redirects from the OAuth flow, + * and should never be called explicitly. Any other calls will simply be + * rejected with BAD_REQUEST. Handles a redirect from Google's + * Authentication server after completing the login & consent flow of OAuth + * handshake. Note that this does not terminate the OAuth flow, it is a hop + * that will always return a 302 to continue to Identity-Aware Proxy + * servers, where the OAuth flow is terminated. + * @alias iap.oauth.clientIds.handleRedirect + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.authuser Auth user parameter passed back by Google's OAuth 2.0 API. + * @param {string} params.clientId The client_id against which the OAuth flow was initiated. + * @param {string=} params.code Authentication code obtained after OAuth login & consent flow. https://tools.ietf.org/html/rfc6749#section-1.3.1 + * @param {string=} params.hd Hosted Domain parameter passed back by Google's OAuth 2.0 API. More information can be found at: https://developers.google.com/identity/protocols/OpenIDConnect#hd-param + * @param {string=} params.prompt Prompt parameter passed back by Google's OAuth 2.0 API. More information can be found at: https://developers.google.com/identity/protocols/OpenIDConnect#prompt + * @param {string=} params.sessionState Session state parameter passed back by Google's OAuth 2.0 API. + * @param {string=} params.state State parameter passed back to the service provider from authentication server in OAuth flow. https://tools.ietf.org/html/rfc6749#section-4.1.1 + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + handleRedirect( + params?: Params$Resource$Oauth$Clientids$Handleredirect, + options?: MethodOptions): AxiosPromise; + handleRedirect( + params: Params$Resource$Oauth$Clientids$Handleredirect, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + handleRedirect( + params: Params$Resource$Oauth$Clientids$Handleredirect, + callback: BodyResponseCallback): void; + handleRedirect(callback: BodyResponseCallback): void; + handleRedirect( + paramsOrCallback?: Params$Resource$Oauth$Clientids$Handleredirect| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Oauth$Clientids$Handleredirect; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Oauth$Clientids$Handleredirect; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/v1beta1/oauth/clientIds/{+clientId}:handleRedirect') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['clientId'], + pathParams: ['clientId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Oauth$Clientids$Handleredirect { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Auth user parameter passed back by Google's OAuth 2.0 API. + */ + authuser?: string; + /** + * The client_id against which the OAuth flow was initiated. + */ + clientId?: string; + /** + * Authentication code obtained after OAuth login & consent flow. + * https://tools.ietf.org/html/rfc6749#section-1.3.1 + */ + code?: string; + /** + * Hosted Domain parameter passed back by Google's OAuth 2.0 API. More + * information can be found at: + * https://developers.google.com/identity/protocols/OpenIDConnect#hd-param + */ + hd?: string; + /** + * Prompt parameter passed back by Google's OAuth 2.0 API. More information + * can be found at: + * https://developers.google.com/identity/protocols/OpenIDConnect#prompt + */ + prompt?: string; + /** + * Session state parameter passed back by Google's OAuth 2.0 API. + */ + sessionState?: string; + /** + * State parameter passed back to the service provider from authentication + * server in OAuth flow. https://tools.ietf.org/html/rfc6749#section-4.1.1 + */ + state?: string; + } + + + + export class Resource$Projects { + root: Iap; + iap_web: Resource$Projects$Iap_web; + constructor(root: Iap) { + this.root = root; + this.getRoot.bind(this); + this.iap_web = new Resource$Projects$Iap_web(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Iap_web { + root: Iap; + services: Resource$Projects$Iap_web$Services; + constructor(root: Iap) { + this.root = root; + this.getRoot.bind(this); + this.services = new Resource$Projects$Iap_web$Services(root); + } + + getRoot() { + return this.root; + } + + + /** + * iap.projects.iap_web.getIamPolicy + * @desc Gets the access control policy for an Identity-Aware Proxy + * protected resource. More information about managing access via IAP can be + * found at: + * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @alias iap.projects.iap_web.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {().GetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Iap_web$Getiampolicy, + options?: MethodOptions): AxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Iap_web$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Projects$Iap_web$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: Params$Resource$Projects$Iap_web$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Iap_web$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Iap_web$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * iap.projects.iap_web.setIamPolicy + * @desc Sets the access control policy for an Identity-Aware Proxy + * protected resource. Replaces any existing policy. More information about + * managing access via IAP can be found at: + * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @alias iap.projects.iap_web.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Iap_web$Setiampolicy, + options?: MethodOptions): AxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Iap_web$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: Params$Resource$Projects$Iap_web$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: Params$Resource$Projects$Iap_web$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Iap_web$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Iap_web$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * iap.projects.iap_web.testIamPermissions + * @desc Returns permissions that a caller has on the Identity-Aware Proxy + * protected resource. If the resource does not exist or the caller does not + * have Identity-Aware Proxy permissions a + * [google.rpc.Code.PERMISSION_DENIED] will be returned. More information + * about managing access via IAP can be found at: + * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @alias iap.projects.iap_web.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Iap_web$Testiampermissions, + options?: MethodOptions): + AxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Iap_web$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + testIamPermissions( + params: Params$Resource$Projects$Iap_web$Testiampermissions, + callback: BodyResponseCallback): + void; + testIamPermissions( + callback: BodyResponseCallback): + void; + testIamPermissions( + paramsOrCallback?: Params$Resource$Projects$Iap_web$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Iap_web$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Iap_web$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Iap_web$Getiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Iap_web$Setiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Iap_web$Testiampermissions { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Iap_web$Services { + root: Iap; + versions: Resource$Projects$Iap_web$Services$Versions; + constructor(root: Iap) { + this.root = root; + this.getRoot.bind(this); + this.versions = new Resource$Projects$Iap_web$Services$Versions(root); + } + + getRoot() { + return this.root; + } + + + /** + * iap.projects.iap_web.services.getIamPolicy + * @desc Gets the access control policy for an Identity-Aware Proxy + * protected resource. More information about managing access via IAP can be + * found at: + * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @alias iap.projects.iap_web.services.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {().GetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Iap_web$Services$Getiampolicy, + options?: MethodOptions): AxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Iap_web$Services$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Projects$Iap_web$Services$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Iap_web$Services$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Iap_web$Services$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Iap_web$Services$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * iap.projects.iap_web.services.setIamPolicy + * @desc Sets the access control policy for an Identity-Aware Proxy + * protected resource. Replaces any existing policy. More information about + * managing access via IAP can be found at: + * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @alias iap.projects.iap_web.services.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Iap_web$Services$Setiampolicy, + options?: MethodOptions): AxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Iap_web$Services$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: Params$Resource$Projects$Iap_web$Services$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Iap_web$Services$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Iap_web$Services$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Iap_web$Services$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * iap.projects.iap_web.services.testIamPermissions + * @desc Returns permissions that a caller has on the Identity-Aware Proxy + * protected resource. If the resource does not exist or the caller does not + * have Identity-Aware Proxy permissions a + * [google.rpc.Code.PERMISSION_DENIED] will be returned. More information + * about managing access via IAP can be found at: + * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @alias iap.projects.iap_web.services.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Iap_web$Services$Testiampermissions, + options?: MethodOptions): + AxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Iap_web$Services$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + testIamPermissions( + params: Params$Resource$Projects$Iap_web$Services$Testiampermissions, + callback: BodyResponseCallback): + void; + testIamPermissions( + callback: BodyResponseCallback): + void; + testIamPermissions( + paramsOrCallback?: + Params$Resource$Projects$Iap_web$Services$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Iap_web$Services$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Iap_web$Services$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Iap_web$Services$Getiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Iap_web$Services$Setiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Iap_web$Services$Testiampermissions { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Iap_web$Services$Versions { + root: Iap; + constructor(root: Iap) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * iap.projects.iap_web.services.versions.getIamPolicy + * @desc Gets the access control policy for an Identity-Aware Proxy + * protected resource. More information about managing access via IAP can be + * found at: + * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @alias iap.projects.iap_web.services.versions.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {().GetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: + Params$Resource$Projects$Iap_web$Services$Versions$Getiampolicy, + options?: MethodOptions): AxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Iap_web$Services$Versions$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Projects$Iap_web$Services$Versions$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Iap_web$Services$Versions$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Iap_web$Services$Versions$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Iap_web$Services$Versions$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * iap.projects.iap_web.services.versions.setIamPolicy + * @desc Sets the access control policy for an Identity-Aware Proxy + * protected resource. Replaces any existing policy. More information about + * managing access via IAP can be found at: + * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @alias iap.projects.iap_web.services.versions.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: + Params$Resource$Projects$Iap_web$Services$Versions$Setiampolicy, + options?: MethodOptions): AxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Iap_web$Services$Versions$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: Params$Resource$Projects$Iap_web$Services$Versions$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Iap_web$Services$Versions$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Iap_web$Services$Versions$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Iap_web$Services$Versions$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * iap.projects.iap_web.services.versions.testIamPermissions + * @desc Returns permissions that a caller has on the Identity-Aware Proxy + * protected resource. If the resource does not exist or the caller does not + * have Identity-Aware Proxy permissions a + * [google.rpc.Code.PERMISSION_DENIED] will be returned. More information + * about managing access via IAP can be found at: + * https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api + * @alias iap.projects.iap_web.services.versions.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: + Params$Resource$Projects$Iap_web$Services$Versions$Testiampermissions, + options?: MethodOptions): + AxiosPromise; + testIamPermissions( + params: + Params$Resource$Projects$Iap_web$Services$Versions$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + testIamPermissions( + params: + Params$Resource$Projects$Iap_web$Services$Versions$Testiampermissions, + callback: BodyResponseCallback): + void; + testIamPermissions( + callback: BodyResponseCallback): + void; + testIamPermissions( + paramsOrCallback?: + Params$Resource$Projects$Iap_web$Services$Versions$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Iap_web$Services$Versions$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Iap_web$Services$Versions$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iap.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Iap_web$Services$Versions$Getiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Iap_web$Services$Versions$Setiampolicy { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Iap_web$Services$Versions$Testiampermissions { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } +} diff --git a/src/apis/index.ts b/src/apis/index.ts index 7aae3438727..0e9b912cab7 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -48,6 +48,7 @@ import * as clouderrorreporting from './clouderrorreporting'; import * as cloudfunctions from './cloudfunctions'; import * as cloudiot from './cloudiot'; import * as cloudkms from './cloudkms'; +import * as cloudprofiler from './cloudprofiler'; import * as cloudresourcemanager from './cloudresourcemanager'; import * as cloudshell from './cloudshell'; import * as cloudtasks from './cloudtasks'; @@ -84,7 +85,9 @@ import * as groupsmigration from './groupsmigration'; import * as groupssettings from './groupssettings'; import * as iam from './iam'; import * as iamcredentials from './iamcredentials'; +import * as iap from './iap'; import * as identitytoolkit from './identitytoolkit'; +import * as indexing from './indexing'; import * as jobs from './jobs'; import * as kgsearch from './kgsearch'; import * as language from './language'; @@ -188,6 +191,7 @@ export const APIS: APIList = { cloudfunctions: cloudfunctions.VERSIONS, cloudiot: cloudiot.VERSIONS, cloudkms: cloudkms.VERSIONS, + cloudprofiler: cloudprofiler.VERSIONS, cloudresourcemanager: cloudresourcemanager.VERSIONS, cloudshell: cloudshell.VERSIONS, cloudtasks: cloudtasks.VERSIONS, @@ -224,7 +228,9 @@ export const APIS: APIList = { groupssettings: groupssettings.VERSIONS, iam: iam.VERSIONS, iamcredentials: iamcredentials.VERSIONS, + iap: iap.VERSIONS, identitytoolkit: identitytoolkit.VERSIONS, + indexing: indexing.VERSIONS, jobs: jobs.VERSIONS, kgsearch: kgsearch.VERSIONS, language: language.VERSIONS, @@ -325,6 +331,7 @@ export class GeneratedAPIs { cloudfunctions = cloudfunctions.cloudfunctions; cloudiot = cloudiot.cloudiot; cloudkms = cloudkms.cloudkms; + cloudprofiler = cloudprofiler.cloudprofiler; cloudresourcemanager = cloudresourcemanager.cloudresourcemanager; cloudshell = cloudshell.cloudshell; cloudtasks = cloudtasks.cloudtasks; @@ -361,7 +368,9 @@ export class GeneratedAPIs { groupssettings = groupssettings.groupssettings; iam = iam.iam; iamcredentials = iamcredentials.iamcredentials; + iap = iap.iap; identitytoolkit = identitytoolkit.identitytoolkit; + indexing = indexing.indexing; jobs = jobs.jobs; kgsearch = kgsearch.kgsearch; language = language.language; @@ -460,6 +469,7 @@ export class GeneratedAPIs { this.cloudfunctions = this.cloudfunctions.bind(this); this.cloudiot = this.cloudiot.bind(this); this.cloudkms = this.cloudkms.bind(this); + this.cloudprofiler = this.cloudprofiler.bind(this); this.cloudresourcemanager = this.cloudresourcemanager.bind(this); this.cloudshell = this.cloudshell.bind(this); this.cloudtasks = this.cloudtasks.bind(this); @@ -496,7 +506,9 @@ export class GeneratedAPIs { this.groupssettings = this.groupssettings.bind(this); this.iam = this.iam.bind(this); this.iamcredentials = this.iamcredentials.bind(this); + this.iap = this.iap.bind(this); this.identitytoolkit = this.identitytoolkit.bind(this); + this.indexing = this.indexing.bind(this); this.jobs = this.jobs.bind(this); this.kgsearch = this.kgsearch.bind(this); this.language = this.language.bind(this); diff --git a/src/apis/indexing/README.md b/src/apis/indexing/README.md new file mode 100644 index 00000000000..3de557c14be --- /dev/null +++ b/src/apis/indexing/README.md @@ -0,0 +1,27 @@ +Google Inc. logo + +# @google/indexing + +> The Indexing API allows developers to share the life cycle of a Web Document with Google. + +## Installation + +```sh +$ npm install @google/indexing +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/google/google-api-nodejs-client). + +## License +This library is licensed under Apache 2.0. Full license text is available in [COPYING](https://github.com/google/google-api-nodejs-client/blob/master/COPYING). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/master/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/google/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/indexing/index.ts b/src/apis/indexing/index.ts new file mode 100644 index 00000000000..ee0d4f38921 --- /dev/null +++ b/src/apis/indexing/index.ts @@ -0,0 +1,28 @@ +// Copyright 2018, Google, LLC. +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {getAPI, GoogleConfigurable} from '../../shared/src'; +import {indexing_v3} from './v3'; + +export const VERSIONS = { + 'v3': indexing_v3.Indexing, +}; + +export function indexing(version: 'v3'): indexing_v3.Indexing; +export function indexing(options: indexing_v3.Options): indexing_v3.Indexing; +export function indexing( + this: GoogleConfigurable, versionOrOptions: 'v3'|indexing_v3.Options) { + return getAPI('indexing', versionOrOptions, VERSIONS, this); +} diff --git a/src/apis/indexing/package.json b/src/apis/indexing/package.json new file mode 100644 index 00000000000..ef3334a2343 --- /dev/null +++ b/src/apis/indexing/package.json @@ -0,0 +1,24 @@ +{ + "name": "@google/indexing", + "version": "0.1.0", + "description": "indexing", + "main": "index.js", + "types": "index.d.ts", + "keywords": ["google"], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/google/google-api-nodejs-client", + "bugs": { + "url" : "https://github.com/google/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url" : "https://github.com/google/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=6.0.0" + }, + "dependencies": { + "googleapis-common": "^0.1.0" + } +} diff --git a/src/apis/indexing/v3.ts b/src/apis/indexing/v3.ts new file mode 100644 index 00000000000..35800abf752 --- /dev/null +++ b/src/apis/indexing/v3.ts @@ -0,0 +1,301 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {AxiosPromise} from 'axios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; + +import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from '../../shared/src'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace indexing_v3 { + export interface Options extends GlobalOptions { + version: 'v3'; + } + + /** + * Indexing API + * + * The Indexing API allows developers to share the life cycle of a Web + * Document with Google. + * + * @example + * const {google} = require('googleapis'); + * const indexing = google.indexing('v3'); + * + * @namespace indexing + * @type {Function} + * @version v3 + * @variation v3 + * @param {object=} options Options for Indexing + */ + export class Indexing { + _options: GlobalOptions; + google?: GoogleConfigurable; + root = this; + + urlNotifications: Resource$Urlnotifications; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.urlNotifications = new Resource$Urlnotifications(this); + } + + getRoot() { + return this.root; + } + } + + /** + * Output for PublishUrlNotification + */ + export interface Schema$PublishUrlNotificationResponse { + /** + * Description of the notification events received for this URL. + */ + urlNotificationMetadata?: Schema$UrlNotificationMetadata; + } + /** + * `UrlNotification` is the resource used in all Indexing API calls. It + * describes one event in the life cycle of a Web Document. + */ + export interface Schema$UrlNotification { + /** + * Creation timestamp for this notification. Users should _not_ specify it, + * the field is ignored at the request time. + */ + notifyTime?: string; + /** + * The URL life cycle event that Google is being notified about. + */ + type?: string; + /** + * The object of this notification. The URL must be owned by the publisher + * of this notification and, in case of `URL_UPDATED` notifications, it + * _must_ be crawlable by Google. + */ + url?: string; + } + /** + * Summary of the most recent Indexing API notifications successfully + * received, for a given URL. + */ + export interface Schema$UrlNotificationMetadata { + /** + * Latest notification received with type `URL_REMOVED`. + */ + latestRemove?: Schema$UrlNotification; + /** + * Latest notification received with type `URL_UPDATED`. + */ + latestUpdate?: Schema$UrlNotification; + /** + * URL to which this metadata refers. + */ + url?: string; + } + + + export class Resource$Urlnotifications { + root: Indexing; + constructor(root: Indexing) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * indexing.urlNotifications.getMetadata + * @desc Gets metadata about a Web Document. This method can _only_ be used + * to query URLs that were previously seen in successful Indexing API + * notifications. Includes the latest `UrlNotification` received via this + * API. + * @alias indexing.urlNotifications.getMetadata + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.url URL that is being queried. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getMetadata( + params?: Params$Resource$Urlnotifications$Getmetadata, + options?: MethodOptions): AxiosPromise; + getMetadata( + params: Params$Resource$Urlnotifications$Getmetadata, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + getMetadata( + params: Params$Resource$Urlnotifications$Getmetadata, + callback: BodyResponseCallback): void; + getMetadata(callback: BodyResponseCallback): + void; + getMetadata( + paramsOrCallback?: Params$Resource$Urlnotifications$Getmetadata| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Urlnotifications$Getmetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlnotifications$Getmetadata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://indexing.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/urlNotifications/metadata') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * indexing.urlNotifications.publish + * @desc Notifies that a URL has been updated or deleted. + * @alias indexing.urlNotifications.publish + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().UrlNotification} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + publish( + params?: Params$Resource$Urlnotifications$Publish, + options?: MethodOptions): + AxiosPromise; + publish( + params: Params$Resource$Urlnotifications$Publish, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + publish( + params: Params$Resource$Urlnotifications$Publish, + callback: BodyResponseCallback): + void; + publish(callback: + BodyResponseCallback): + void; + publish( + paramsOrCallback?: Params$Resource$Urlnotifications$Publish| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Urlnotifications$Publish; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urlnotifications$Publish; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://indexing.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/urlNotifications:publish') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Urlnotifications$Getmetadata { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * URL that is being queried. + */ + url?: string; + } + export interface Params$Resource$Urlnotifications$Publish { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + + /** + * Request body metadata + */ + requestBody?: Schema$UrlNotification; + } +} diff --git a/src/apis/jobs/v2.ts b/src/apis/jobs/v2.ts index a56e3b8eff1..bc37627d1c5 100644 --- a/src/apis/jobs/v2.ts +++ b/src/apis/jobs/v2.ts @@ -493,14 +493,19 @@ export namespace jobs_v2 { */ export interface Schema$CreateJobRequest { /** - * If set to `true`, the service will not attempt to resolve a more precise - * address for the job. + * Deprecated. Please use processing_options. This flag is ignored if + * processing_options is set. Optional. If set to `true`, the service does + * not attempt to resolve a more precise address for the job. */ disableStreetAddressResolution?: boolean; /** * Required. The Job to be created. */ job?: Schema$Job; + /** + * Optional. Options for job processing. + */ + processingOptions?: Schema$JobProcessingOptions; } /** * Custom attribute values that are either filterable or non-filterable. @@ -537,9 +542,9 @@ export namespace jobs_v2 { export interface Schema$CustomAttributeHistogramRequest { /** * Required. Specifies the custom field key to perform a histogram on. If - * specified without `long_value_buckets` or `long_value_min_max`, a - * histogram on string values of the given `key` is triggered, otherwise - * histogram is performed on long values. + * specified without `long_value_histogram_bucketing_option`, histogram on + * string values of the given `key` is triggered, otherwise histogram is + * performed on long values. */ key?: string; /** @@ -1116,10 +1121,9 @@ export namespace jobs_v2 { * structured fields. For the best search experience, use of the structured * rather than custom fields is recommended. Data stored in these custom * fields fields are indexed and searched against by keyword searches (see - * SearchJobsRequest.custom_field_filters][]). To list jobs by custom - * fields, see ListCustomFieldsRequest.field_id. The map key must be a - * number between 1-20. If an invalid key is provided on job create or - * update, an error is returned. + * SearchJobsRequest.custom_field_filters][]). The map key must be a number + * between 1-20. If an invalid key is provided on job create or update, an + * error is returned. */ filterableCustomFields?: any; /** @@ -1416,6 +1420,24 @@ export namespace jobs_v2 { */ radiusMeters?: number; } + /** + * Input only. Options for job processing. + */ + export interface Schema$JobProcessingOptions { + /** + * Optional. If set to `true`, the service does not attempt to resolve a + * more precise address for the job. + */ + disableStreetAddressResolution?: boolean; + /** + * Optional. Option for job HTML content sanitization. Applied fields are: + * * description * applicationInstruction * incentives * qualifications * + * responsibilities HTML tags in these fields may be stripped if + * sanitiazation is not disabled. Defaults to + * HtmlSanitization.SIMPLE_FORMATTING_ONLY. + */ + htmlSanitization?: string; + } /** * Input only. The query required to perform a search query or histogram. */ @@ -1484,9 +1506,9 @@ export namespace jobs_v2 { /** * Optional. The employment type filter specifies the employment type of * jobs to search against, such as EmploymentType.FULL_TIME. If a value is - * not specified, jobs in the search results includes any employment type. - * If multiple values are specified, jobs in the search results include any - * of the specified employment types. + * not specified, jobs in the search results include any employment type. If + * multiple values are specified, jobs in the search results include any of + * the specified employment types. */ employmentTypes?: string[]; /** @@ -1502,7 +1524,7 @@ export namespace jobs_v2 { /** * Optional. The location filter specifies geo-regions containing the jobs * to search against. See LocationFilter for more information. If a - * location value isn'tt specified, jobs fitting the other search + * location value isn't specified, jobs fitting the other search * criteria are retrieved regardless of where they're located. If * multiple values are specified, jobs are retrieved from any of the * specified locations, and, if different values are specified for the @@ -1608,8 +1630,9 @@ export namespace jobs_v2 { */ export interface Schema$LocationFilter { /** - * Optional. The distance from the address in miles to search. The default - * distance is 20 miles and maximum distance is 5,000 miles. + * Optional. The distance_in_miles is applied when the location being + * searched for is identified as a city or smaller. When the location being + * searched for is a state or larger, this field is ignored. */ distanceInMiles?: number; /** @@ -1870,8 +1893,8 @@ export namespace jobs_v2 { * www.bar.com, then this field is set to "foo.com" for use on the * job board, and "bar.com" for use on the career site. If this * field is not available for some reason, send "UNKNOWN". Note - * that any improvements to the {{ api_name }} model for a particular tenant - * site, rely on this field being set correctly to some domain. + * that any improvements to the service model for a particular tenant site + * rely on this field being set correctly to some domain. */ domain?: string; /** @@ -1879,9 +1902,9 @@ export namespace jobs_v2 { * as the duration of an end user's interaction with the service over a * period. Obfuscate this field for privacy concerns before providing it to * the API. If this field is not available for some reason, please send - * "UNKNOWN". Note that any improvements to the {{ api_name }} - * model for a particular tenant site, rely on this field being set - * correctly to some unique session_id. + * "UNKNOWN". Note that any improvements to the service model for + * a particular tenant site, rely on this field being set correctly to some + * unique session_id. */ sessionId?: string; /** @@ -1890,9 +1913,9 @@ export namespace jobs_v2 { * this value in order to have the strongest positive impact on search * quality. Obfuscate this field for privacy concerns before providing it to * the service. If this field is not available for some reason, please send - * "UNKNOWN". Note that any improvements to the {{ api_name }} - * model for a particular tenant site, rely on this field being set - * correctly to some unique user_id. + * "UNKNOWN". Note that any improvements to the service model for + * a particular tenant site, rely on this field being set correctly to some + * unique user_id. */ userId?: string; } @@ -2102,14 +2125,21 @@ export namespace jobs_v2 { */ export interface Schema$UpdateJobRequest { /** - * If set to `true`, the service will not attempt resolve a more precise - * address for the job. + * Deprecated. Please use processing_options. This flag is ignored if + * processing_options is set. Optional. If set to `true`, the service does + * not attempt resolve a more precise address for the job. */ disableStreetAddressResolution?: boolean; /** * Required. The Job to be updated. */ job?: Schema$Job; + /** + * Optional. Options for job processing. + * UpdateJobRequest.disable_street_address_resolution is ignored if this + * flag is set. + */ + processingOptions?: Schema$JobProcessingOptions; /** * Optional but strongly recommended to be provided for the best service * experience. If update_job_fields is provided, only the specified fields diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 00960da9177..40dd3525822 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -33,7 +33,7 @@ export namespace logging_v2 { /** * Stackdriver Logging API * - * Writes log entries and manages your Stackdriver Logging configuration. + * Writes log entries and manages your Logging configuration. * * @example * const {google} = require('googleapis'); @@ -441,11 +441,11 @@ export namespace logging_v2 { httpRequest?: Schema$HttpRequest; /** * Optional. A unique identifier for the log entry. If you provide a value, - * then Stackdriver Logging considers other log entries in the same project, - * with the same timestamp, and with the same insert_id to be duplicates - * which can be removed. If omitted in new log entries, then Stackdriver - * Logging assigns its own unique identifier. The insert_id is also used to - * order log entries that have the same timestamp value. + * then Logging considers other log entries in the same project, with the + * same timestamp, and with the same insert_id to be duplicates which can be + * removed. If omitted in new log entries, then Logging assigns its own + * unique identifier. The insert_id is also used to order log entries that + * have the same timestamp value. */ insertId?: string; /** @@ -495,7 +495,7 @@ export namespace logging_v2 { */ protoPayload?: any; /** - * Output only. The time the log entry was received by Stackdriver Logging. + * Output only. The time the log entry was received by Logging. */ receiveTimestamp?: string; /** @@ -517,9 +517,9 @@ export namespace logging_v2 { sourceLocation?: Schema$LogEntrySourceLocation; /** * Optional. The span ID within the trace associated with the log entry. For - * Stackdriver Trace spans, this is the same format that the Stackdriver - * Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte - * array, such as <code>"000000000000004a"</code>. + * Trace spans, this is the same format that the Trace API v2 uses: a + * 16-character hexadecimal encoding of an 8-byte array, such as + * <code>"000000000000004a"</code>. */ spanId?: string; /** @@ -530,13 +530,13 @@ export namespace logging_v2 { * Optional. The time the event described by the log entry occurred. This * time is used to compute the log entry's age and to enforce the logs * retention period. If this field is omitted in a new log entry, then - * Stackdriver Logging assigns it the current time. Timestamps have - * nanosecond accuracy, but trailing zeros in the fractional seconds might - * be omitted when the timestamp is displayed.Incoming log entries should - * have timestamps that are no more than the logs retention period in the - * past, and no more than 24 hours in the future. Log entries outside those - * time boundaries will not be available when calling entries.list, but - * those log entries can still be exported with LogSinks. + * Logging assigns it the current time. Timestamps have nanosecond accuracy, + * but trailing zeros in the fractional seconds might be omitted when the + * timestamp is displayed.Incoming log entries should have timestamps that + * are no more than the logs retention period in the past, and no more than + * 24 hours in the future. Log entries outside those time boundaries will + * not be available when calling entries.list, but those log entries can + * still be exported with LogSinks. */ timestamp?: string; /** @@ -601,12 +601,11 @@ export namespace logging_v2 { line?: string; } /** - * Specifies a set of log entries that are not to be stored in Stackdriver - * Logging. If your project receives a large volume of logs, you might be able - * to use exclusions to reduce your chargeable logs. Exclusions are processed - * after log sinks, so you can export log entries before they are excluded. - * Audit log entries and log entries from Amazon Web Services are never - * excluded. + * Specifies a set of log entries that are not to be stored in Logging. If + * your project receives a large volume of logs, you might be able to use + * exclusions to reduce your chargeable logs. Exclusions are processed after + * log sinks, so you can export log entries before they are excluded. Audit + * log entries and log entries from Amazon Web Services are never excluded. */ export interface Schema$LogExclusion { /** @@ -816,9 +815,9 @@ export namespace logging_v2 { startTime?: string; /** * Output only. An IAM identity&mdash;a service account or - * group&mdash;under which Stackdriver Logging writes the exported log - * entries to the sink's destination. This field is set by sinks.create - * and sinks.update, based on the setting of unique_writer_identity in those + * group&mdash;under which Logging writes the exported log entries to + * the sink's destination. This field is set by sinks.create and + * sinks.update, based on the setting of unique_writer_identity in those * methods.Until you grant this identity write-access to the destination, * log entry exports from this sink will fail. For more information, see * Granting access for a resource. Consult the destination service's @@ -852,6 +851,10 @@ export namespace logging_v2 { * latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; + /** + * Optional. Metadata which can be used to guide usage of the metric. + */ + metadata?: Schema$MetricDescriptorMetadata; /** * Whether the metric records instantaneous values, changes to a value, etc. * Some combinations of metric_kind and value_type might not be supported. @@ -901,6 +904,28 @@ export namespace logging_v2 { */ valueType?: string; } + /** + * Additional annotations that can be used to guide the usage of a metric. + */ + export interface Schema$MetricDescriptorMetadata { + /** + * The delay of data points caused by ingestion. Data points older than this + * age are guaranteed to be ingested and available to be read, excluding + * data loss due to errors. + */ + ingestDelay?: string; + /** + * The launch stage of the metric definition. + */ + launchStage?: string; + /** + * The sampling period of metric data points. For metrics which are written + * periodically, consecutive data points are stored at this time interval, + * excluding data loss due to errors. Metrics with a higher granularity have + * a smaller sampling period. + */ + samplePeriod?: string; + } /** * An object representing a resource that can be used for monitoring, logging, * billing, or other purposes. Examples include virtual machine instances, @@ -980,19 +1005,17 @@ export namespace logging_v2 { * Auxiliary metadata for a MonitoredResource object. MonitoredResource * objects contain the minimum set of information to uniquely identify a * monitored resource instance. There is some other useful auxiliary metadata. - * Google Stackdriver Monitoring & Logging uses an ingestion pipeline to - * extract metadata for cloud resources of all types , and stores the metadata - * in this message. + * Monitoring and Logging use an ingestion pipeline to extract metadata for + * cloud resources of all types, and store the metadata in this message. */ export interface Schema$MonitoredResourceMetadata { /** * Output only. Values for predefined system metadata labels. System labels - * are a kind of metadata extracted by Google Stackdriver. Stackdriver - * determines what system labels are useful and how to obtain their values. - * Some examples: "machine_image", "vpc", - * "subnet_id", "security_group", "name", etc. - * System label values can be only strings, Boolean values, or a list of - * strings. For example: { "name": "my-test-instance", + * are a kind of metadata extracted by Google, including + * "machine_image", "vpc", "subnet_id", + * "security_group", "name", etc. System label values + * can be only strings, Boolean values, or a list of strings. For example: { + * "name": "my-test-instance", * "security_group": ["a", "b", * "c"], "spot_instance": false } */ @@ -1205,23 +1228,22 @@ export namespace logging_v2 { */ dryRun?: boolean; /** - * Required. The log entries to send to Stackdriver Logging. The order of - * log entries in this list does not matter. Values supplied in this - * method's log_name, resource, and labels fields are copied into those - * log entries in this list that do not include values for their - * corresponding fields. For more information, see the LogEntry type.If the - * timestamp or insert_id fields are missing in log entries, then this - * method supplies the current time or a unique identifier, respectively. - * The supplied values are chosen so that, among the log entries that did - * not supply their own values, the entries earlier in the list will sort - * before the entries later in the list. See the entries.list method.Log - * entries with timestamps that are more than the logs retention period in - * the past or more than 24 hours in the future will not be available when - * calling entries.list. However, those log entries can still be exported - * with LogSinks.To improve throughput and to avoid exceeding the quota - * limit for calls to entries.write, you should try to include several log - * entries in this list, rather than calling this method for each individual - * log entry. + * Required. The log entries to send to Logging. The order of log entries in + * this list does not matter. Values supplied in this method's log_name, + * resource, and labels fields are copied into those log entries in this + * list that do not include values for their corresponding fields. For more + * information, see the LogEntry type.If the timestamp or insert_id fields + * are missing in log entries, then this method supplies the current time or + * a unique identifier, respectively. The supplied values are chosen so + * that, among the log entries that did not supply their own values, the + * entries earlier in the list will sort before the entries later in the + * list. See the entries.list method.Log entries with timestamps that are + * more than the logs retention period in the past or more than 24 hours in + * the future will not be available when calling entries.list. However, + * those log entries can still be exported with LogSinks.To improve + * throughput and to avoid exceeding the quota limit for calls to + * entries.write, you should try to include several log entries in this + * list, rather than calling this method for each individual log entry. */ entries?: Schema$LogEntry[]; /** @@ -1960,7 +1982,7 @@ export namespace logging_v2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". - * @param {boolean=} params.uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. + * @param {boolean=} params.uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. * @param {().LogSink} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2375,13 +2397,13 @@ export namespace logging_v2 { * Optional. Determines the kind of IAM identity returned as writer_identity * in the new sink. If this value is omitted or set to false, and if the * sink's parent is a project, then the value returned as writer_identity is - * the same group or service account used by Stackdriver Logging before the - * addition of writer identities to this API. The sink's destination must be - * in the same project as the sink itself.If this field is set to true, or - * if the sink is owned by a non-project resource such as an organization, - * then the value of writer_identity will be a unique service account used - * only for exports from the new sink. For more information, see - * writer_identity in LogSink. + * the same group or service account used by Logging before the addition of + * writer identities to this API. The sink's destination must be in the same + * project as the sink itself.If this field is set to true, or if the sink + * is owned by a non-project resource such as an organization, then the + * value of writer_identity will be a unique service account used only for + * exports from the new sink. For more information, see writer_identity in + * LogSink. */ uniqueWriterIdentity?: boolean; @@ -2559,7 +2581,7 @@ export namespace logging_v2 { /** * logging.entries.list * @desc Lists log entries. Use this method to retrieve log entries from - * Stackdriver Logging. For ways to export log entries, see Exporting Logs. + * Logging. For ways to export log entries, see Exporting Logs. * @alias logging.entries.list * @memberOf! () * @@ -2624,12 +2646,12 @@ export namespace logging_v2 { /** * logging.entries.write - * @desc Writes log entries to Stackdriver Logging. This API method is the - * only way to send log entries to Stackdriver Logging. This method is used, - * directly or indirectly, by the Stackdriver Logging agent (fluentd) and - * all logging libraries configured to use Stackdriver Logging. A single - * request may contain log entries for a maximum of 1000 different resources - * (projects, organizations, billing accounts or folders) + * @desc Writes log entries to Logging. This API method is the only way to + * send log entries to Logging. This method is used, directly or indirectly, + * by the Logging agent (fluentd) and all logging libraries configured to + * use Logging. A single request may contain log entries for a maximum of + * 1000 different resources (projects, organizations, billing accounts or + * folders) * @alias logging.entries.write * @memberOf! () * @@ -3860,7 +3882,7 @@ export namespace logging_v2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". - * @param {boolean=} params.uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. + * @param {boolean=} params.uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. * @param {().LogSink} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4274,13 +4296,13 @@ export namespace logging_v2 { * Optional. Determines the kind of IAM identity returned as writer_identity * in the new sink. If this value is omitted or set to false, and if the * sink's parent is a project, then the value returned as writer_identity is - * the same group or service account used by Stackdriver Logging before the - * addition of writer identities to this API. The sink's destination must be - * in the same project as the sink itself.If this field is set to true, or - * if the sink is owned by a non-project resource such as an organization, - * then the value of writer_identity will be a unique service account used - * only for exports from the new sink. For more information, see - * writer_identity in LogSink. + * the same group or service account used by Logging before the addition of + * writer identities to this API. The sink's destination must be in the same + * project as the sink itself.If this field is set to true, or if the sink + * is owned by a non-project resource such as an organization, then the + * value of writer_identity will be a unique service account used only for + * exports from the new sink. For more information, see writer_identity in + * LogSink. */ uniqueWriterIdentity?: boolean; @@ -4648,8 +4670,7 @@ export namespace logging_v2 { /** * logging.monitoredResourceDescriptors.list - * @desc Lists the descriptors for monitored resource types used by - * Stackdriver Logging. + * @desc Lists the descriptors for monitored resource types used by Logging. * @alias logging.monitoredResourceDescriptors.list * @memberOf! () * @@ -5438,7 +5459,7 @@ export namespace logging_v2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". - * @param {boolean=} params.uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. + * @param {boolean=} params.uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. * @param {().LogSink} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5853,13 +5874,13 @@ export namespace logging_v2 { * Optional. Determines the kind of IAM identity returned as writer_identity * in the new sink. If this value is omitted or set to false, and if the * sink's parent is a project, then the value returned as writer_identity is - * the same group or service account used by Stackdriver Logging before the - * addition of writer identities to this API. The sink's destination must be - * in the same project as the sink itself.If this field is set to true, or - * if the sink is owned by a non-project resource such as an organization, - * then the value of writer_identity will be a unique service account used - * only for exports from the new sink. For more information, see - * writer_identity in LogSink. + * the same group or service account used by Logging before the addition of + * writer identities to this API. The sink's destination must be in the same + * project as the sink itself.If this field is set to true, or if the sink + * is owned by a non-project resource such as an organization, then the + * value of writer_identity will be a unique service account used only for + * exports from the new sink. For more information, see writer_identity in + * LogSink. */ uniqueWriterIdentity?: boolean; @@ -7151,7 +7172,7 @@ export namespace logging_v2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". - * @param {boolean=} params.uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. + * @param {boolean=} params.uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. * @param {().LogSink} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7565,13 +7586,13 @@ export namespace logging_v2 { * Optional. Determines the kind of IAM identity returned as writer_identity * in the new sink. If this value is omitted or set to false, and if the * sink's parent is a project, then the value returned as writer_identity is - * the same group or service account used by Stackdriver Logging before the - * addition of writer identities to this API. The sink's destination must be - * in the same project as the sink itself.If this field is set to true, or - * if the sink is owned by a non-project resource such as an organization, - * then the value of writer_identity will be a unique service account used - * only for exports from the new sink. For more information, see - * writer_identity in LogSink. + * the same group or service account used by Logging before the addition of + * writer identities to this API. The sink's destination must be in the same + * project as the sink itself.If this field is set to true, or if the sink + * is owned by a non-project resource such as an organization, then the + * value of writer_identity will be a unique service account used only for + * exports from the new sink. For more information, see writer_identity in + * LogSink. */ uniqueWriterIdentity?: boolean; @@ -7757,7 +7778,7 @@ export namespace logging_v2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". - * @param {boolean=} params.uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. + * @param {boolean=} params.uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. * @param {().LogSink} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8092,13 +8113,13 @@ export namespace logging_v2 { * Optional. Determines the kind of IAM identity returned as writer_identity * in the new sink. If this value is omitted or set to false, and if the * sink's parent is a project, then the value returned as writer_identity is - * the same group or service account used by Stackdriver Logging before the - * addition of writer identities to this API. The sink's destination must be - * in the same project as the sink itself.If this field is set to true, or - * if the sink is owned by a non-project resource such as an organization, - * then the value of writer_identity will be a unique service account used - * only for exports from the new sink. For more information, see - * writer_identity in LogSink. + * the same group or service account used by Logging before the addition of + * writer identities to this API. The sink's destination must be in the same + * project as the sink itself.If this field is set to true, or if the sink + * is owned by a non-project resource such as an organization, then the + * value of writer_identity will be a unique service account used only for + * exports from the new sink. For more information, see writer_identity in + * LogSink. */ uniqueWriterIdentity?: boolean; diff --git a/src/apis/logging/v2beta1.ts b/src/apis/logging/v2beta1.ts index 436df7309a7..435b6920804 100644 --- a/src/apis/logging/v2beta1.ts +++ b/src/apis/logging/v2beta1.ts @@ -33,7 +33,7 @@ export namespace logging_v2beta1 { /** * Stackdriver Logging API * - * Writes log entries and manages your Stackdriver Logging configuration. + * Writes log entries and manages your Logging configuration. * * @example * const {google} = require('googleapis'); @@ -418,11 +418,11 @@ export namespace logging_v2beta1 { httpRequest?: Schema$HttpRequest; /** * Optional. A unique identifier for the log entry. If you provide a value, - * then Stackdriver Logging considers other log entries in the same project, - * with the same timestamp, and with the same insert_id to be duplicates - * which can be removed. If omitted in new log entries, then Stackdriver - * Logging assigns its own unique identifier. The insert_id is also used to - * order log entries that have the same timestamp value. + * then Logging considers other log entries in the same project, with the + * same timestamp, and with the same insert_id to be duplicates which can be + * removed. If omitted in new log entries, then Logging assigns its own + * unique identifier. The insert_id is also used to order log entries that + * have the same timestamp value. */ insertId?: string; /** @@ -472,7 +472,7 @@ export namespace logging_v2beta1 { */ protoPayload?: any; /** - * Output only. The time the log entry was received by Stackdriver Logging. + * Output only. The time the log entry was received by Logging. */ receiveTimestamp?: string; /** @@ -494,9 +494,9 @@ export namespace logging_v2beta1 { sourceLocation?: Schema$LogEntrySourceLocation; /** * Optional. The span ID within the trace associated with the log entry. For - * Stackdriver Trace spans, this is the same format that the Stackdriver - * Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte - * array, such as <code>"000000000000004a"</code>. + * Trace spans, this is the same format that the Trace API v2 uses: a + * 16-character hexadecimal encoding of an 8-byte array, such as + * <code>"000000000000004a"</code>. */ spanId?: string; /** @@ -507,13 +507,13 @@ export namespace logging_v2beta1 { * Optional. The time the event described by the log entry occurred. This * time is used to compute the log entry's age and to enforce the logs * retention period. If this field is omitted in a new log entry, then - * Stackdriver Logging assigns it the current time. Timestamps have - * nanosecond accuracy, but trailing zeros in the fractional seconds might - * be omitted when the timestamp is displayed.Incoming log entries should - * have timestamps that are no more than the logs retention period in the - * past, and no more than 24 hours in the future. Log entries outside those - * time boundaries will not be available when calling entries.list, but - * those log entries can still be exported with LogSinks. + * Logging assigns it the current time. Timestamps have nanosecond accuracy, + * but trailing zeros in the fractional seconds might be omitted when the + * timestamp is displayed.Incoming log entries should have timestamps that + * are no more than the logs retention period in the past, and no more than + * 24 hours in the future. Log entries outside those time boundaries will + * not be available when calling entries.list, but those log entries can + * still be exported with LogSinks. */ timestamp?: string; /** @@ -757,9 +757,9 @@ export namespace logging_v2beta1 { startTime?: string; /** * Output only. An IAM identity&mdash;a service account or - * group&mdash;under which Stackdriver Logging writes the exported log - * entries to the sink's destination. This field is set by sinks.create - * and sinks.update, based on the setting of unique_writer_identity in those + * group&mdash;under which Logging writes the exported log entries to + * the sink's destination. This field is set by sinks.create and + * sinks.update, based on the setting of unique_writer_identity in those * methods.Until you grant this identity write-access to the destination, * log entry exports from this sink will fail. For more information, see * Granting access for a resource. Consult the destination service's @@ -793,6 +793,10 @@ export namespace logging_v2beta1 { * latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; + /** + * Optional. Metadata which can be used to guide usage of the metric. + */ + metadata?: Schema$MetricDescriptorMetadata; /** * Whether the metric records instantaneous values, changes to a value, etc. * Some combinations of metric_kind and value_type might not be supported. @@ -842,6 +846,28 @@ export namespace logging_v2beta1 { */ valueType?: string; } + /** + * Additional annotations that can be used to guide the usage of a metric. + */ + export interface Schema$MetricDescriptorMetadata { + /** + * The delay of data points caused by ingestion. Data points older than this + * age are guaranteed to be ingested and available to be read, excluding + * data loss due to errors. + */ + ingestDelay?: string; + /** + * The launch stage of the metric definition. + */ + launchStage?: string; + /** + * The sampling period of metric data points. For metrics which are written + * periodically, consecutive data points are stored at this time interval, + * excluding data loss due to errors. Metrics with a higher granularity have + * a smaller sampling period. + */ + samplePeriod?: string; + } /** * An object representing a resource that can be used for monitoring, logging, * billing, or other purposes. Examples include virtual machine instances, @@ -921,19 +947,17 @@ export namespace logging_v2beta1 { * Auxiliary metadata for a MonitoredResource object. MonitoredResource * objects contain the minimum set of information to uniquely identify a * monitored resource instance. There is some other useful auxiliary metadata. - * Google Stackdriver Monitoring & Logging uses an ingestion pipeline to - * extract metadata for cloud resources of all types , and stores the metadata - * in this message. + * Monitoring and Logging use an ingestion pipeline to extract metadata for + * cloud resources of all types, and store the metadata in this message. */ export interface Schema$MonitoredResourceMetadata { /** * Output only. Values for predefined system metadata labels. System labels - * are a kind of metadata extracted by Google Stackdriver. Stackdriver - * determines what system labels are useful and how to obtain their values. - * Some examples: "machine_image", "vpc", - * "subnet_id", "security_group", "name", etc. - * System label values can be only strings, Boolean values, or a list of - * strings. For example: { "name": "my-test-instance", + * are a kind of metadata extracted by Google, including + * "machine_image", "vpc", "subnet_id", + * "security_group", "name", etc. System label values + * can be only strings, Boolean values, or a list of strings. For example: { + * "name": "my-test-instance", * "security_group": ["a", "b", * "c"], "spot_instance": false } */ @@ -1146,23 +1170,22 @@ export namespace logging_v2beta1 { */ dryRun?: boolean; /** - * Required. The log entries to send to Stackdriver Logging. The order of - * log entries in this list does not matter. Values supplied in this - * method's log_name, resource, and labels fields are copied into those - * log entries in this list that do not include values for their - * corresponding fields. For more information, see the LogEntry type.If the - * timestamp or insert_id fields are missing in log entries, then this - * method supplies the current time or a unique identifier, respectively. - * The supplied values are chosen so that, among the log entries that did - * not supply their own values, the entries earlier in the list will sort - * before the entries later in the list. See the entries.list method.Log - * entries with timestamps that are more than the logs retention period in - * the past or more than 24 hours in the future will not be available when - * calling entries.list. However, those log entries can still be exported - * with LogSinks.To improve throughput and to avoid exceeding the quota - * limit for calls to entries.write, you should try to include several log - * entries in this list, rather than calling this method for each individual - * log entry. + * Required. The log entries to send to Logging. The order of log entries in + * this list does not matter. Values supplied in this method's log_name, + * resource, and labels fields are copied into those log entries in this + * list that do not include values for their corresponding fields. For more + * information, see the LogEntry type.If the timestamp or insert_id fields + * are missing in log entries, then this method supplies the current time or + * a unique identifier, respectively. The supplied values are chosen so + * that, among the log entries that did not supply their own values, the + * entries earlier in the list will sort before the entries later in the + * list. See the entries.list method.Log entries with timestamps that are + * more than the logs retention period in the past or more than 24 hours in + * the future will not be available when calling entries.list. However, + * those log entries can still be exported with LogSinks.To improve + * throughput and to avoid exceeding the quota limit for calls to + * entries.write, you should try to include several log entries in this + * list, rather than calling this method for each individual log entry. */ entries?: Schema$LogEntry[]; /** @@ -1567,7 +1590,7 @@ export namespace logging_v2beta1 { /** * logging.entries.list * @desc Lists log entries. Use this method to retrieve log entries from - * Stackdriver Logging. For ways to export log entries, see Exporting Logs. + * Logging. For ways to export log entries, see Exporting Logs. * @example * * // BEFORE RUNNING: * // --------------- @@ -1700,12 +1723,12 @@ export namespace logging_v2beta1 { /** * logging.entries.write - * @desc Writes log entries to Stackdriver Logging. This API method is the - * only way to send log entries to Stackdriver Logging. This method is used, - * directly or indirectly, by the Stackdriver Logging agent (fluentd) and - * all logging libraries configured to use Stackdriver Logging. A single - * request may contain log entries for a maximum of 1000 different resources - * (projects, organizations, billing accounts or folders) + * @desc Writes log entries to Logging. This API method is the only way to + * send log entries to Logging. This method is used, directly or indirectly, + * by the Logging agent (fluentd) and all logging libraries configured to + * use Logging. A single request may contain log entries for a maximum of + * 1000 different resources (projects, organizations, billing accounts or + * folders) * @example * * // BEFORE RUNNING: * // --------------- @@ -1863,8 +1886,7 @@ export namespace logging_v2beta1 { /** * logging.monitoredResourceDescriptors.list - * @desc Lists the descriptors for monitored resource types used by - * Stackdriver Logging. + * @desc Lists the descriptors for monitored resource types used by Logging. * @example * * // BEFORE RUNNING: * // --------------- @@ -3532,7 +3554,7 @@ export namespace logging_v2beta1 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". - * @param {boolean=} params.uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. + * @param {boolean=} params.uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. * @param {().LogSink} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4132,13 +4154,13 @@ export namespace logging_v2beta1 { * Optional. Determines the kind of IAM identity returned as writer_identity * in the new sink. If this value is omitted or set to false, and if the * sink's parent is a project, then the value returned as writer_identity is - * the same group or service account used by Stackdriver Logging before the - * addition of writer identities to this API. The sink's destination must be - * in the same project as the sink itself.If this field is set to true, or - * if the sink is owned by a non-project resource such as an organization, - * then the value of writer_identity will be a unique service account used - * only for exports from the new sink. For more information, see - * writer_identity in LogSink. + * the same group or service account used by Logging before the addition of + * writer identities to this API. The sink's destination must be in the same + * project as the sink itself.If this field is set to true, or if the sink + * is owned by a non-project resource such as an organization, then the + * value of writer_identity will be a unique service account used only for + * exports from the new sink. For more information, see writer_identity in + * LogSink. */ uniqueWriterIdentity?: boolean; diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index 29044f0a81f..b5b233035b0 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -274,10 +274,29 @@ export namespace ml_v1 { * Output only. The details of a failure or a cancellation. */ errorMessage?: string; + /** + * `etag` is used for optimistic concurrency control as a way to help + * prevent simultaneous updates of a job from overwriting each other. It is + * strongly suggested that systems make use of the `etag` in the + * read-modify-write cycle to perform job updates in order to avoid race + * conditions: An `etag` is returned in the response to `GetJob`, and + * systems are expected to put that etag in the request to `UpdateJob` to + * ensure that their change will be applied to the same version of the job. + */ + etag?: string; /** * Required. The user-specified id of the job. */ jobId?: string; + /** + * Optional. One or more labels that you can add, to organize your jobs. + * Each label is a key-value pair, where both the key and the value are + * arbitrary strings that you supply. For more information, see the + * documentation on <a + * href="/ml-engine/docs/tensorflow/resource-labels">using + * labels</a>. + */ + labels?: any; /** * Input parameters to create a prediction job. */ @@ -392,6 +411,25 @@ export namespace ml_v1 { * Optional. The description specified for the model when it was created. */ description?: string; + /** + * `etag` is used for optimistic concurrency control as a way to help + * prevent simultaneous updates of a model from overwriting each other. It + * is strongly suggested that systems make use of the `etag` in the + * read-modify-write cycle to perform model updates in order to avoid race + * conditions: An `etag` is returned in the response to `GetModel`, and + * systems are expected to put that etag in the request to `UpdateModel` to + * ensure that their change will be applied to the model as intended. + */ + etag?: string; + /** + * Optional. One or more labels that you can add, to organize your models. + * Each label is a key-value pair, where both the key and the value are + * arbitrary strings that you supply. For more information, see the + * documentation on <a + * href="/ml-engine/docs/tensorflow/resource-labels">using + * labels</a>. + */ + labels?: any; /** * Required. The name specified for the model when it was created. The * model name must be unique within the project it is created in. @@ -431,6 +469,11 @@ export namespace ml_v1 { * Indicates whether a request to cancel this operation has been made. */ isCancellationRequested?: boolean; + /** + * The user labels, inherited from the model or the model version being + * operated on. + */ + labels?: any; /** * Contains the name of the model associated with the operation. */ @@ -664,8 +707,7 @@ export namespace ml_v1 { * NVIDIA Tesla P100 GPUs. The availability of these GPUs is in the * <i>Beta</i> launch stage. </dd> * <dt>cloud_tpu</dt> <dd> A TPU VM including one - * Cloud TPU. The availability of Cloud TPU is in <i>Beta</i> - * launch stage. See more about <a + * Cloud TPU. See more about <a * href="/ml-engine/docs/tensorflow/using-tpus">using TPUs to * train your model</a>. </dd> </dl> You must set * this value when `scaleTier` is set to `CUSTOM`. @@ -799,6 +841,16 @@ export namespace ml_v1 { * Output only. The details of a failure or a cancellation. */ errorMessage?: string; + /** + * `etag` is used for optimistic concurrency control as a way to help + * prevent simultaneous updates of a model from overwriting each other. It + * is strongly suggested that systems make use of the `etag` in the + * read-modify-write cycle to perform model updates in order to avoid race + * conditions: An `etag` is returned in the response to `GetVersion`, and + * systems are expected to put that etag in the request to `UpdateVersion` + * to ensure that their change will be applied to the model as intended. + */ + etag?: string; /** * Optional. The machine learning framework Cloud ML Engine uses to train * this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, @@ -814,19 +866,26 @@ export namespace ml_v1 { * [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault). */ isDefault?: boolean; + /** + * Optional. One or more labels that you can add, to organize your model + * versions. Each label is a key-value pair, where both the key and the + * value are arbitrary strings that you supply. For more information, see + * the documentation on <a + * href="/ml-engine/docs/tensorflow/resource-labels">using + * labels</a>. + */ + labels?: any; /** * Output only. The time the version was last used for prediction. */ lastUseTime?: string; /** * Optional. The type of machine on which to serve the model. Currently only - * applies to online prediction service. Naming design doc for CMLE online - * prediction Machine Types: - * https://docs.google.com/document/d/1V3tko3VJ64PcpsmNxCXiPoPGccL9_K8gX1YjC8UofzQ/edit#heading=h.7lvy6owfx4eh. - * The following are currently supported and will be deprecated in Beta - * release. mls1-highmem-1 1 core 2 Gb RAM mls1-highcpu-4 4 - * core 2 Gb RAM The following are available in Beta: mls1-c1-m2 1 core - * 2 Gb RAM Default mls1-c4-m2 1 core 4 Gb RAM + * applies to online prediction service. The following are currently + * supported and will be deprecated in Beta release. mls1-highmem-1 1 + * core 2 Gb RAM mls1-highcpu-4 4 core 2 Gb RAM The following are + * available in Beta: mls1-c1-m2 1 core 2 Gb RAM Default + * mls1-c4-m2 4 core 2 Gb RAM */ machineType?: string; /** @@ -937,7 +996,7 @@ export namespace ml_v1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } @@ -3246,13 +3305,13 @@ export namespace ml_v1 { /** * ml.projects.models.versions.patch * @desc Updates the specified Version resource. Currently the only - * supported field to update is `description`. + * update-able fields are `description` and `autoScaling.minNodes`. * @alias ml.projects.models.versions.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The name of the model. - * @param {string=} params.updateMask Required. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: { "description": "foo" } Currently the only supported update mask is`description`. + * @param {string=} params.updateMask Required. Specifies the path, relative to `Version`, of the field to update. Must be present and non-empty. For example, to change the description of a version to "foo", the `update_mask` parameter would be specified as `description`, and the `PATCH` request body would specify the new value, as follows: { "description": "foo" } Currently the only supported update mask fields are `description` and `autoScaling.minNodes`. * @param {().GoogleCloudMlV1__Version} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3477,7 +3536,8 @@ export namespace ml_v1 { * description of a version to "foo", the `update_mask` parameter would be * specified as `description`, and the `PATCH` request body would specify * the new value, as follows: { "description": "foo" } - * Currently the only supported update mask is`description`. + * Currently the only supported update mask fields are `description` and + * `autoScaling.minNodes`. */ updateMask?: string; diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 36ded0e37f3..afd7a9eaf52 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -1095,6 +1095,10 @@ export namespace monitoring_v3 { * latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; + /** + * Optional. Metadata which can be used to guide usage of the metric. + */ + metadata?: Schema$MetricDescriptorMetadata; /** * Whether the metric records instantaneous values, changes to a value, etc. * Some combinations of metric_kind and value_type might not be supported. @@ -1114,11 +1118,28 @@ export namespace monitoring_v3 { */ type?: string; /** - * Optional. The unit in which the metric value is reported. For example, - * kBy/s means kilobytes/sec, and 1 is the dimensionless unit. The supported - * units are a subset of The Unified Code for Units of Measure standard - * (http://unitsofmeasure.org/ucum.html).<br><br> This field is - * part of the metric's documentation, but it is ignored by Stackdriver. + * The unit in which the metric value is reported. It is only applicable if + * the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are + * a subset of The Unified Code for Units of Measure + * (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit + * By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (10**3) + * M mega (10**6) G giga (10**9) T tera (10**12) P peta (10**15) E exa + * (10**18) Z zetta (10**21) Y yotta (10**24) m milli (10**-3) u micro + * (10**-6) n nano (10**-9) p pico (10**-12) f femto (10**-15) a atto + * (10**-18) z zepto (10**-21) y yocto (10**-24) Ki kibi (2**10) Mi mebi + * (2**20) Gi gibi (2**30) Ti tebi (2**40)GrammarThe grammar also includes + * these connectors: / division (as an infix operator, e.g. 1/s). . + * multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit + * is as follows: Expression = Component { "." Component } { + * "/" Component } ; Component = ( [ PREFIX ] UNIT | + * "%" ) [ Annotation ] | Annotation | + * "1" ; Annotation = "{" NAME "}" + * ; Notes: Annotation is just a comment if it follows a UNIT and is + * equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, + * By{transmitted}/s == By/s. NAME is a sequence of non-blank printable + * ASCII characters not containing '{' or '}'. 1 represents + * dimensionless value 1, such as in 1/s. % represents dimensionless value + * 1/100, and annotates values giving a percentage. */ unit?: string; /** @@ -1127,6 +1148,28 @@ export namespace monitoring_v3 { */ valueType?: string; } + /** + * Additional annotations that can be used to guide the usage of a metric. + */ + export interface Schema$MetricDescriptorMetadata { + /** + * The delay of data points caused by ingestion. Data points older than this + * age are guaranteed to be ingested and available to be read, excluding + * data loss due to errors. + */ + ingestDelay?: string; + /** + * The launch stage of the metric definition. + */ + launchStage?: string; + /** + * The sampling period of metric data points. For metrics which are written + * periodically, consecutive data points are stored at this time interval, + * excluding data loss due to errors. Metrics with a higher granularity have + * a smaller sampling period. + */ + samplePeriod?: string; + } /** * A condition type that compares a collection of time series against a * threshold. @@ -1290,19 +1333,17 @@ export namespace monitoring_v3 { * Auxiliary metadata for a MonitoredResource object. MonitoredResource * objects contain the minimum set of information to uniquely identify a * monitored resource instance. There is some other useful auxiliary metadata. - * Google Stackdriver Monitoring & Logging uses an ingestion pipeline to - * extract metadata for cloud resources of all types , and stores the metadata - * in this message. + * Monitoring and Logging use an ingestion pipeline to extract metadata for + * cloud resources of all types, and store the metadata in this message. */ export interface Schema$MonitoredResourceMetadata { /** * Output only. Values for predefined system metadata labels. System labels - * are a kind of metadata extracted by Google Stackdriver. Stackdriver - * determines what system labels are useful and how to obtain their values. - * Some examples: "machine_image", "vpc", - * "subnet_id", "security_group", "name", etc. - * System label values can be only strings, Boolean values, or a list of - * strings. For example: { "name": "my-test-instance", + * are a kind of metadata extracted by Google, including + * "machine_image", "vpc", "subnet_id", + * "security_group", "name", etc. System label values + * can be only strings, Boolean values, or a list of strings. For example: { + * "name": "my-test-instance", * "security_group": ["a", "b", * "c"], "spot_instance": false } */ diff --git a/src/apis/poly/v1.ts b/src/apis/poly/v1.ts index 75dbeb427ee..6a8791376c6 100644 --- a/src/apis/poly/v1.ts +++ b/src/apis/poly/v1.ts @@ -390,14 +390,14 @@ export namespace poly_v1 { z?: number; } /** - * A response message from a request to list. This is returned in the response - * field of the Operation. + * A response message from a request to startImport. This is returned in the + * response field of the Operation. */ export interface Schema$StartAssetImportResponse { /** * The id of newly created asset. If this is empty when the operation is * complete it means the import failed. Please refer to the - * asset_import_message field to understand what went wrong. + * assetImportMessages field to understand what went wrong. */ assetId?: string; /** diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 06323158494..1e4c0d7ab62 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -98,7 +98,7 @@ export namespace pubsub_v1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } @@ -109,6 +109,11 @@ export namespace pubsub_v1 { * for production use. It is not subject to any SLA or deprecation policy. */ export interface Schema$CreateSnapshotRequest { + /** + * See <a href="/pubsub/docs/labels"> Creating and managing + * labels</a>. + */ + labels?: any; /** * The subscription whose backlog the snapshot retains. Specifically, the * created snapshot is guaranteed to retain: (a) The existing backlog on @@ -353,10 +358,10 @@ export namespace pubsub_v1 { */ export interface Schema$PullResponse { /** - * Received Pub/Sub messages. The Pub/Sub system will return zero messages - * if there are no more available in the backlog. The Pub/Sub system may - * return fewer than the `maxMessages` requested even if there are more - * messages available in the backlog. + * Received Pub/Sub messages. The list will be empty if there are no more + * messages available in the backlog. For JSON, the response can be entirely + * empty. The Pub/Sub system may return fewer than the `maxMessages` + * requested even if there are more messages available in the backlog. */ receivedMessages?: Schema$ReceivedMessage[]; } @@ -462,6 +467,11 @@ export namespace pubsub_v1 { * would expire in less than 1 hour after creation. */ expireTime?: string; + /** + * See <a href="/pubsub/docs/labels"> Creating and managing + * labels</a>. + */ + labels?: any; /** * The name of the snapshot. */ @@ -493,6 +503,11 @@ export namespace pubsub_v1 { * system will eventually redeliver the message. */ ackDeadlineSeconds?: number; + /** + * See <a href="/pubsub/docs/labels"> Creating and managing + * labels</a>. + */ + labels?: any; /** * How long to retain unacknowledged messages in the subscription's * backlog, from the moment a message is published. If @@ -564,6 +579,11 @@ export namespace pubsub_v1 { * A topic resource. */ export interface Schema$Topic { + /** + * See <a href="/pubsub/docs/labels"> Creating and managing + * labels</a>. + */ + labels?: any; /** * The name of the topic. It must have the format * `"projects/{project}/topics/{topic}"`. `{topic}` must start @@ -605,6 +625,23 @@ export namespace pubsub_v1 { */ updateMask?: string; } + /** + * Request for the UpdateTopic method. + */ + export interface Schema$UpdateTopicRequest { + /** + * The updated topic object. + */ + topic?: Schema$Topic; + /** + * Indicates which fields in the provided topic to update. Must be specified + * and non-empty. Note that if `update_mask` contains + * "message_storage_policy" then the new value will be determined + * based on the policy configured at the project or organization level. The + * `message_storage_policy` must not be set in the `topic` provided above. + */ + updateMask?: string; + } export class Resource$Projects { @@ -2618,8 +2655,7 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.pull - * @desc Pulls messages from the server. Returns an empty list if there are - * no messages available in the backlog. The server may return `UNAVAILABLE` + * @desc Pulls messages from the server. The server may return `UNAVAILABLE` * if there are too many concurrent pull requests pending for the given * subscription. * @example @@ -3950,6 +3986,73 @@ export namespace pubsub_v1 { } + /** + * pubsub.projects.topics.patch + * @desc Updates an existing topic. Note that certain properties of a topic + * are not modifiable. + * @alias pubsub.projects.topics.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * @param {().UpdateTopicRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Projects$Topics$Patch, + options?: MethodOptions): AxiosPromise; + patch( + params: Params$Resource$Projects$Topics$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Topics$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Topics$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Topics$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Topics$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://pubsub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * pubsub.projects.topics.publish * @desc Adds one or more messages to the topic. Returns `NOT_FOUND` if the @@ -4422,6 +4525,27 @@ export namespace pubsub_v1 { */ project?: string; } + export interface Params$Resource$Projects$Topics$Patch { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the topic. It must have the format + * `"projects/{project}/topics/{topic}"`. `{topic}` must start with a + * letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes + * (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or + * percent signs (`%`). It must be between 3 and 255 characters in length, + * and it must not start with `"goog"`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpdateTopicRequest; + } export interface Params$Resource$Projects$Topics$Publish { /** * Auth client or API Key for the request diff --git a/src/apis/pubsub/v1beta2.ts b/src/apis/pubsub/v1beta2.ts index f9e4bbf80c6..623f9733836 100644 --- a/src/apis/pubsub/v1beta2.ts +++ b/src/apis/pubsub/v1beta2.ts @@ -98,7 +98,7 @@ export namespace pubsub_v1beta2 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index a5906c359b1..99aaa336a35 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -303,21 +303,6 @@ export namespace redis_v1beta1 { */ name?: string; } - /** - * This location metadata represents additional configuration options for a - * given location where a Redis instance may be created. All fields are output - * only. It is returned as content of the - * `google.cloud.location.Location.metadata` field. - */ - export interface Schema$LocationMetadata { - /** - * Output only. The set of available zones in the location. The map is keyed - * by the lowercase ID of each zone, as defined by GCE. These keys can be - * specified in `location_id` or `alternative_location_id` fields when - * creating a Redis instance. - */ - availableZones?: any; - } /** * This resource represents a long-running operation that is the result of a * network API call. @@ -357,56 +342,6 @@ export namespace redis_v1beta1 { */ response?: any; } - /** - * This operation metadata represents the state of operations that may have - * happened or are happening on the instance. All fields are output only. It - * is returned as content of the `google.longrunning.Operation.metadata` - * field. The `google.longrunning.Operation.name` field will be of the form - * `projects/{project_id}/locations/{location_id}/operations/{operation_id}` - * and the name for a `ListOperations` request will be of the form - * `projects/{project_id}/locations/{location_id}` On a ListOperations - * request where {location_id} is "-", all regions available to the - * {project_id} are queried and the results aggregated. If a location is not - * available, a dummy `google.longrunning.Operation` entry will be included in - * the `operations` field of the response, with the `name` field set to a - * value of the form - * `projects/{project_id}/locations/{location_id}/operations/-` and the `done` - * field will be set and the `result.error` field set with the `code` field - * set to `google.rpc.Code.DEADLINE_EXCEEDED` and the `message` field set to - * `location unavailable for ListOperations`. The Operation metadata` field - * will not be set for such a dummy operation. - */ - export interface Schema$OperationMetadata { - /** - * Output only. The time the operation was created. - */ - createTime?: string; - /** - * Output only. Detailed operation progress, if available. - */ - detail?: string; - /** - * Output only. The time the operation was completed. - */ - endTime?: string; - /** - * Output only. The operation type. - */ - operationType?: string; - /** - * Output only. The time the operation was started. - */ - startTime?: string; - /** - * Output only. The current state of the operation. - */ - state?: string; - /** - * Output only. Server-defined resource path for the target of the - * operation. - */ - target?: string; - } /** * The `Status` type defines a logical error model that is suitable for * different programming environments, including REST APIs and RPC APIs. It is @@ -460,11 +395,6 @@ export namespace redis_v1beta1 { */ message?: string; } - /** - * Defines specific information for a particular zone. Currently empty and - * reserved for future use only. - */ - export interface Schema$ZoneMetadata {} export class Resource$Projects { diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index 8bf14639b3b..a09317b447c 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -90,7 +90,7 @@ export namespace runtimeconfig_v1beta1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } diff --git a/src/apis/script/README.md b/src/apis/script/README.md index d8c5aef6cbf..2bb33ca5785 100644 --- a/src/apis/script/README.md +++ b/src/apis/script/README.md @@ -2,7 +2,7 @@ # @google/script -> An API for managing and executing Google Apps Script projects. Note: In order to use this API in your apps, you must enable it for use. To allow other apps to manage your scripts, you must grant them access. +> An API for managing and executing Google Apps Script projects. ## Installation diff --git a/src/apis/script/v1.ts b/src/apis/script/v1.ts index 2109aeb2db7..b98efd34193 100644 --- a/src/apis/script/v1.ts +++ b/src/apis/script/v1.ts @@ -33,14 +33,7 @@ export namespace script_v1 { /** * Apps Script API * - * An API for managing and executing Google Apps Script projects. <aside - * class="note"><b>Note</b>: In order to use this API - * in your apps, you must <a - * href="/apps-script/api/how-tos/enable#using_the_apps_script_api_in_your_app"> - * enable it for use</a>. To allow other apps to manage your scripts, - * you must <a - * href="/apps-script/api/how-tos/enable#granting_third-party_applications_access_to_your_script_projects"> - * grant them access</a>.</aside> + * An API for managing and executing Google Apps Script projects. * * @example * const {google} = require('googleapis'); @@ -375,7 +368,7 @@ export namespace script_v1 { * Representation of a single script process execution that was started from * the script editor, a trigger, an application, or using the Apps Script API. * This is distinct from the `Operation` resource, which only represents - * exeuctions started via the Apps Script API. + * executions started via the Apps Script API. */ export interface Schema$GoogleAppsScriptTypeProcess { /** diff --git a/src/apis/servicebroker/v1.ts b/src/apis/servicebroker/v1.ts index 93c9b9d6ca4..58bdb139967 100644 --- a/src/apis/servicebroker/v1.ts +++ b/src/apis/servicebroker/v1.ts @@ -71,6 +71,13 @@ export namespace servicebroker_v1 { * Associates `members` with a `role`. */ export interface Schema$GoogleIamV1__Binding { + /** + * Unimplemented. The condition that is associated with this binding. NOTE: + * an unsatisfied condition will not allow user access via current binding. + * Different bindings, including their conditions, are examined + * independently. + */ + condition?: Schema$GoogleType__Expr; /** * Specifies the identities requesting access for a Cloud Platform resource. * `members` can have the following values: * `allUsers`: A special @@ -89,7 +96,7 @@ export namespace servicebroker_v1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } @@ -170,6 +177,35 @@ export namespace servicebroker_v1 { */ permissions?: string[]; } + /** + * Represents an expression text. Example: title: "User account + * presence" description: "Determines whether the request has a + * user account" expression: "size(request.user) > 0" + */ + export interface Schema$GoogleType__Expr { + /** + * An optional description of the expression. This is a longer text which + * describes the expression, e.g. when hovered over it in a UI. + */ + description?: string; + /** + * Textual representation of an expression in Common Expression Language + * syntax. The application context of the containing message determines + * which well-known feature set of CEL is supported. + */ + expression?: string; + /** + * An optional string indicating the location of the expression for error + * reporting, e.g. a file name and a position in the file. + */ + location?: string; + /** + * An optional title for the expression, i.e. a short string describing its + * purpose. This can be used e.g. in UIs which allow to enter the + * expression. + */ + title?: string; + } export class Resource$V1 { diff --git a/src/apis/servicebroker/v1alpha1.ts b/src/apis/servicebroker/v1alpha1.ts index 4de40d7ad1c..30ed3741100 100644 --- a/src/apis/servicebroker/v1alpha1.ts +++ b/src/apis/servicebroker/v1alpha1.ts @@ -495,6 +495,13 @@ export namespace servicebroker_v1alpha1 { * Associates `members` with a `role`. */ export interface Schema$GoogleIamV1__Binding { + /** + * Unimplemented. The condition that is associated with this binding. NOTE: + * an unsatisfied condition will not allow user access via current binding. + * Different bindings, including their conditions, are examined + * independently. + */ + condition?: Schema$GoogleType__Expr; /** * Specifies the identities requesting access for a Cloud Platform resource. * `members` can have the following values: * `allUsers`: A special @@ -513,7 +520,7 @@ export namespace servicebroker_v1alpha1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } @@ -594,6 +601,35 @@ export namespace servicebroker_v1alpha1 { */ permissions?: string[]; } + /** + * Represents an expression text. Example: title: "User account + * presence" description: "Determines whether the request has a + * user account" expression: "size(request.user) > 0" + */ + export interface Schema$GoogleType__Expr { + /** + * An optional description of the expression. This is a longer text which + * describes the expression, e.g. when hovered over it in a UI. + */ + description?: string; + /** + * Textual representation of an expression in Common Expression Language + * syntax. The application context of the containing message determines + * which well-known feature set of CEL is supported. + */ + expression?: string; + /** + * An optional string indicating the location of the expression for error + * reporting, e.g. a file name and a position in the file. + */ + location?: string; + /** + * An optional title for the expression, i.e. a short string describing its + * purpose. This can be used e.g. in UIs which allow to enter the + * expression. + */ + title?: string; + } export class Resource$Projects { diff --git a/src/apis/servicebroker/v1beta1.ts b/src/apis/servicebroker/v1beta1.ts index ff5827e52b7..12a6989f256 100644 --- a/src/apis/servicebroker/v1beta1.ts +++ b/src/apis/servicebroker/v1beta1.ts @@ -568,6 +568,13 @@ export namespace servicebroker_v1beta1 { * Associates `members` with a `role`. */ export interface Schema$GoogleIamV1__Binding { + /** + * Unimplemented. The condition that is associated with this binding. NOTE: + * an unsatisfied condition will not allow user access via current binding. + * Different bindings, including their conditions, are examined + * independently. + */ + condition?: Schema$GoogleType__Expr; /** * Specifies the identities requesting access for a Cloud Platform resource. * `members` can have the following values: * `allUsers`: A special @@ -586,7 +593,7 @@ export namespace servicebroker_v1beta1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } @@ -675,6 +682,35 @@ export namespace servicebroker_v1beta1 { * representation for `Empty` is empty JSON object `{}`. */ export interface Schema$GoogleProtobuf__Empty {} + /** + * Represents an expression text. Example: title: "User account + * presence" description: "Determines whether the request has a + * user account" expression: "size(request.user) > 0" + */ + export interface Schema$GoogleType__Expr { + /** + * An optional description of the expression. This is a longer text which + * describes the expression, e.g. when hovered over it in a UI. + */ + description?: string; + /** + * Textual representation of an expression in Common Expression Language + * syntax. The application context of the containing message determines + * which well-known feature set of CEL is supported. + */ + expression?: string; + /** + * An optional string indicating the location of the expression for error + * reporting, e.g. a file name and a position in the file. + */ + location?: string; + /** + * An optional title for the expression, i.e. a short string describing its + * purpose. This can be used e.g. in UIs which allow to enter the + * expression. + */ + title?: string; + } export class Resource$Projects { diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index 18beb8394d5..a1789e0b8f0 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -1256,6 +1256,10 @@ export namespace serviceconsumermanagement_v1 { * latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; + /** + * Optional. Metadata which can be used to guide usage of the metric. + */ + metadata?: Schema$MetricDescriptorMetadata; /** * Whether the metric records instantaneous values, changes to a value, etc. * Some combinations of `metric_kind` and `value_type` might not be @@ -1310,6 +1314,28 @@ export namespace serviceconsumermanagement_v1 { */ valueType?: string; } + /** + * Additional annotations that can be used to guide the usage of a metric. + */ + export interface Schema$MetricDescriptorMetadata { + /** + * The delay of data points caused by ingestion. Data points older than this + * age are guaranteed to be ingested and available to be read, excluding + * data loss due to errors. + */ + ingestDelay?: string; + /** + * The launch stage of the metric definition. + */ + launchStage?: string; + /** + * The sampling period of metric data points. For metrics which are written + * periodically, consecutive data points are stored at this time interval, + * excluding data loss due to errors. Metrics with a higher granularity have + * a smaller sampling period. + */ + samplePeriod?: string; + } /** * Bind API methods to metrics. Binding a method to a metric causes that * metric's configured quota behaviors to apply to the method call. @@ -2095,8 +2121,7 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$TenantProjectConfig { /** - * Billing account properties. It might be specified explicitly, or created - * from the specified group during provisioning + * Billing account properties. Billing account must be specified. */ billingConfig?: Schema$BillingConfig; /** diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index 8e7f02daed9..7240523a294 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -200,6 +200,64 @@ export namespace servicecontrol_v1 { */ status?: Schema$Status; } + /** + * This message defines request authentication attributes. Terminology is + * based on the JSON Web Token (JWT) standard, but the terms also correlate to + * concepts in other standards. + */ + export interface Schema$Auth { + /** + * A list of access level resource names that allow resources to be accessed + * by authenticated requester. It is part of Secure GCP processing for the + * incoming request. An access level string has the format: + * "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}" + * Example: + * "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL" + */ + accessLevels?: string[]; + /** + * The intended audience(s) for this authentication information. Reflects + * the audience (`aud`) claim within a JWT. The audience value(s) depends on + * the `issuer`, but typically include one or more of the following pieces + * of information: * The services intended to receive the credential such + * as ["pubsub.googleapis.com", + * "storage.googleapis.com"] * A set of service-based scopes. For + * example, ["https://www.googleapis.com/auth/cloud-platform"] + * * The client id of an app, such as the Firebase project id for JWTs from + * Firebase Auth. Consult the documentation for the credential issuer to + * determine the information provided. + */ + audiences?: string[]; + /** + * Structured claims presented with the credential. JWTs include `{key: + * value}` pairs for standard and private claims. The following is a subset + * of the standard required and optional claims that would typically be + * presented for a Google-based JWT: {'iss': + * 'accounts.google.com', 'sub': + * '113289723416554971153', 'aud': + * ['123456789012', 'pubsub.googleapis.com'], 'azp': + * '123456789012.apps.googleusercontent.com', 'email': + * 'jsmith@example.com', 'iat': 1353601026, + * 'exp': 1353604926} SAML assertions are similarly specified, but + * with an identity provider dependent structure. + */ + claims?: any; + /** + * The authorized presenter of the credential. Reflects the optional + * Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. + * For example, a Google Cloud Platform client id looks as follows: + * "123456789012.apps.googleusercontent.com". + */ + presenter?: string; + /** + * The authenticated principal. Reflects the issuer (`iss`) and subject + * (`sub`) claims within a JWT. The issuer and subject should be `/` + * delimited, with `/` percent-encoded within the subject fragment. For + * Google accounts, the principal format is: + * "https://accounts.google.com/{id}" + */ + principal?: string; + } /** * Authentication information for the operation. */ @@ -240,6 +298,13 @@ export namespace servicecontrol_v1 { * bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID */ resource?: string; + /** + * Resource attributes used in IAM condition evaluation. This field contains + * resource attributes like resource type and resource name. To get the + * whole view of the attributes used in IAM condition evaluation, the user + * must also look into `AuditLog.request_metadata.request_attributes`. + */ + resourceAttributes?: Schema$Resource; } /** * Defines the errors to be returned in @@ -979,6 +1044,78 @@ export namespace servicecontrol_v1 { */ serviceConfigId?: string; } + /** + * This message defines attributes for an HTTP request. If the actual request + * is not an HTTP request, the runtime system should try to map the actual + * request to an equivalent HTTP request. + */ + export interface Schema$Request { + /** + * The request authentication. May be absent for unauthenticated requests. + * Derived from the HTTP request `Authorization` header or equivalent. + */ + auth?: Schema$Auth; + /** + * The HTTP URL fragment. No URL decoding is performed. + */ + fragment?: string; + /** + * The HTTP request headers. If multiple headers share the same key, they + * must be merged according to the HTTP spec. All header keys must be + * lowercased, because HTTP header keys are case-insensitive. + */ + headers?: any; + /** + * The HTTP request `Host` header value. + */ + host?: string; + /** + * The unique ID for a request, which can be propagated to downstream + * systems. The ID should have low probability of collision within a single + * day for a specific service. + */ + id?: string; + /** + * The HTTP request method, such as `GET`, `POST`. + */ + method?: string; + /** + * The HTTP URL path. + */ + path?: string; + /** + * The network protocol used with the request, such as "http/1.1", + * "spdy/3", "h2", "h2c", "webrtc", + * "tcp", "udp", "quic". See + * https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids + * for details. + */ + protocol?: string; + /** + * The HTTP URL query in the format of `name1=value`&name2=value2`, as + * it appears in the first line of the HTTP request. No decoding is + * performed. + */ + query?: string; + /** + * A special parameter for request reason. It is used by security systems to + * associate auditing information with a request. + */ + reason?: string; + /** + * The HTTP URL scheme, such as `http` and `https`. + */ + scheme?: string; + /** + * The HTTP request size in bytes. If unknown, it must be -1. + */ + size?: string; + /** + * The timestamp when the `destination` service receives the first byte of + * the request. + */ + time?: string; + } /** * Metadata about the request. */ @@ -1013,6 +1150,50 @@ export namespace servicecontrol_v1 { * was made from the `my-project` App Engine app. NOLINT */ callerSuppliedUserAgent?: string; + /** + * Request attributes used in IAM condition evaluation. This field contains + * request attributes like request time and access levels associated with + * the request. To get the whole view of the attributes used in IAM + * condition evaluation, the user must also look into + * `AuditLog.authentication_info.resource_attributes`. + */ + requestAttributes?: Schema$Request; + } + /** + * This message defines core attributes for a resource. A resource is an + * addressable (named) entity provided by the destination service. For + * example, a file stored on a network storage service. + */ + export interface Schema$Resource { + /** + * The labels or tags on the resource, such as AWS resource tags and + * Kubernetes resource labels. + */ + labels?: any; + /** + * The stable identifier (name) of a resource on the `service`. A resource + * can be logically identified as + * "//{resource.service}/{resource.name}". The differences between + * a resource name and a URI are: * Resource name is a logical + * identifier, independent of network protocol and API version. For + * example, `//pubsub.googleapis.com/projects/123/topics/news-feed`. * + * URI often includes protocol and version information, so it can be + * used directly by applications. For example, + * `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`. See + * https://cloud.google.com/apis/design/resource_names for details. + */ + name?: string; + /** + * The name of the service that this resource belongs to, such as + * `pubsub.googleapis.com`. The service may be different from the DNS + * hostname that actually serves the request. + */ + service?: string; + /** + * The type of the resource. The scheme is platform-specific because + * different platforms define their resources differently. + */ + type?: string; } /** * Describes a resource associated with this operation. @@ -1025,6 +1206,13 @@ export namespace servicecontrol_v1 { * “organizations/<organization-id>” */ resourceContainer?: string; + /** + * The location of the resource. If not empty, the resource will be checked + * against location policy. The value must be a valid zone, region or + * multiregion. For example: "europe-west4" or + * "northamerica-northeast1-a" + */ + resourceLocation?: string; /** * Name of the resource. This is used for auditing purposes. */ diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index d3d3af30561..e21f981f4b2 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -403,6 +403,13 @@ export namespace servicemanagement_v1 { * Associates `members` with a `role`. */ export interface Schema$Binding { + /** + * Unimplemented. The condition that is associated with this binding. NOTE: + * an unsatisfied condition will not allow user access via current binding. + * Different bindings, including their conditions, are examined + * independently. + */ + condition?: Schema$Expr; /** * Specifies the identities requesting access for a Cloud Platform resource. * `members` can have the following values: * `allUsers`: A special @@ -421,7 +428,7 @@ export namespace servicemanagement_v1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } @@ -873,6 +880,35 @@ export namespace servicemanagement_v1 { */ authorization?: Schema$AuthorizationConfig; } + /** + * Represents an expression text. Example: title: "User account + * presence" description: "Determines whether the request has a + * user account" expression: "size(request.user) > 0" + */ + export interface Schema$Expr { + /** + * An optional description of the expression. This is a longer text which + * describes the expression, e.g. when hovered over it in a UI. + */ + description?: string; + /** + * Textual representation of an expression in Common Expression Language + * syntax. The application context of the containing message determines + * which well-known feature set of CEL is supported. + */ + expression?: string; + /** + * An optional string indicating the location of the expression for error + * reporting, e.g. a file name and a position in the file. + */ + location?: string; + /** + * An optional title for the expression, i.e. a short string describing its + * purpose. This can be used e.g. in UIs which allow to enter the + * expression. + */ + title?: string; + } /** * A single field of a message type. */ @@ -1468,6 +1504,10 @@ export namespace servicemanagement_v1 { * latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; + /** + * Optional. Metadata which can be used to guide usage of the metric. + */ + metadata?: Schema$MetricDescriptorMetadata; /** * Whether the metric records instantaneous values, changes to a value, etc. * Some combinations of `metric_kind` and `value_type` might not be @@ -1522,6 +1562,28 @@ export namespace servicemanagement_v1 { */ valueType?: string; } + /** + * Additional annotations that can be used to guide the usage of a metric. + */ + export interface Schema$MetricDescriptorMetadata { + /** + * The delay of data points caused by ingestion. Data points older than this + * age are guaranteed to be ingested and available to be read, excluding + * data loss due to errors. + */ + ingestDelay?: string; + /** + * The launch stage of the metric definition. + */ + launchStage?: string; + /** + * The sampling period of metric data points. For metrics which are written + * periodically, consecutive data points are stored at this time interval, + * excluding data loss due to errors. Metrics with a higher granularity have + * a smaller sampling period. + */ + samplePeriod?: string; + } /** * Bind API methods to metrics. Binding a method to a metric causes that * metric's configured quota behaviors to apply to the method call. diff --git a/src/apis/serviceusage/index.ts b/src/apis/serviceusage/index.ts index d66c305d7c2..5df79af61ea 100644 --- a/src/apis/serviceusage/index.ts +++ b/src/apis/serviceusage/index.ts @@ -14,18 +14,25 @@ /*! THIS FILE IS AUTO-GENERATED */ import {getAPI, GoogleConfigurable} from '../../shared/src'; +import {serviceusage_v1} from './v1'; import {serviceusage_v1beta1} from './v1beta1'; export const VERSIONS = { + 'v1': serviceusage_v1.Serviceusage, 'v1beta1': serviceusage_v1beta1.Serviceusage, }; +export function serviceusage(version: 'v1'): serviceusage_v1.Serviceusage; +export function serviceusage(options: serviceusage_v1.Options): + serviceusage_v1.Serviceusage; export function serviceusage(version: 'v1beta1'): serviceusage_v1beta1.Serviceusage; export function serviceusage(options: serviceusage_v1beta1.Options): serviceusage_v1beta1.Serviceusage; -export function serviceusage( +export function serviceusage< + T = serviceusage_v1.Serviceusage | serviceusage_v1beta1.Serviceusage>( this: GoogleConfigurable, - versionOrOptions: 'v1beta1'|serviceusage_v1beta1.Options) { + versionOrOptions: 'v1'| + serviceusage_v1.Options|'v1beta1'|serviceusage_v1beta1.Options) { return getAPI('serviceusage', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts new file mode 100644 index 00000000000..28052749633 --- /dev/null +++ b/src/apis/serviceusage/v1.ts @@ -0,0 +1,3066 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {AxiosPromise} from 'axios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; + +import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from '../../shared/src'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace serviceusage_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + /** + * Service Usage API + * + * Enables services that service consumers want to use on Google Cloud + * Platform, lists the available or enabled services, or disables services + * that service consumers no longer use. + * + * @example + * const {google} = require('googleapis'); + * const serviceusage = google.serviceusage('v1'); + * + * @namespace serviceusage + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Serviceusage + */ + export class Serviceusage { + _options: GlobalOptions; + google?: GoogleConfigurable; + root = this; + + operations: Resource$Operations; + services: Resource$Services; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.operations = new Resource$Operations(this); + this.services = new Resource$Services(this); + } + + getRoot() { + return this.root; + } + } + + /** + * Api is a light-weight descriptor for an API Interface. Interfaces are also + * described as "protocol buffer services" in some contexts, such as + * by the "service" keyword in a .proto file, but they are different + * from API Services, which represent a concrete implementation of an + * interface as opposed to simply a description of methods and bindings. They + * are also sometimes simply referred to as "APIs" in other + * contexts, such as the name of this message itself. See + * https://cloud.google.com/apis/design/glossary for detailed terminology. + */ + export interface Schema$Api { + /** + * The methods of this interface, in unspecified order. + */ + methods?: Schema$Method[]; + /** + * Included interfaces. See Mixin. + */ + mixins?: Schema$Mixin[]; + /** + * The fully qualified name of this interface, including package name + * followed by the interface's simple name. + */ + name?: string; + /** + * Any metadata attached to the interface. + */ + options?: Schema$Option[]; + /** + * Source context for the protocol buffer service represented by this + * message. + */ + sourceContext?: Schema$SourceContext; + /** + * The source syntax of the service. + */ + syntax?: string; + /** + * A version string for this interface. If specified, must have the form + * `major-version.minor-version`, as in `1.10`. If the minor version is + * omitted, it defaults to zero. If the entire version field is empty, the + * major version is derived from the package name, as outlined below. If the + * field is not empty, the version in the package name will be verified to + * be consistent with what is provided here. The versioning schema uses + * [semantic versioning](http://semver.org) where the major version number + * indicates a breaking change and the minor version an additive, + * non-breaking change. Both version numbers are signals to users what to + * expect from different versions, and should be carefully chosen based on + * the product plan. The major version is also reflected in the package + * name of the interface, which must end in `v<major-version>`, as in + * `google.feature.v1`. For major versions 0 and 1, the suffix can be + * omitted. Zero major versions must only be used for experimental, non-GA + * interfaces. + */ + version?: string; + } + /** + * `Authentication` defines the authentication configuration for an API. + * Example for an API targeted for external use: name: + * calendar.googleapis.com authentication: providers: - id: + * google_calendar_auth jwks_uri: + * https://www.googleapis.com/oauth2/v1/certs issuer: + * https://securetoken.google.com rules: - selector: "*" + * requirements: provider_id: google_calendar_auth + */ + export interface Schema$Authentication { + /** + * Defines a set of authentication providers that a service supports. + */ + providers?: Schema$AuthProvider[]; + /** + * A list of authentication rules that apply to individual API methods. + * **NOTE:** All service configuration rules follow "last one + * wins" order. + */ + rules?: Schema$AuthenticationRule[]; + } + /** + * Authentication rules for the service. By default, if a method has any + * authentication requirements, every request must include a valid credential + * matching one of the requirements. It's an error to include more than + * one kind of credential in a single request. If a method doesn't have + * any auth requirements, request credentials will be ignored. + */ + export interface Schema$AuthenticationRule { + /** + * If true, the service accepts API keys without any other credential. + */ + allowWithoutCredential?: boolean; + /** + * The requirements for OAuth credentials. + */ + oauth?: Schema$OAuthRequirements; + /** + * Requirements for additional authentication providers. + */ + requirements?: Schema$AuthRequirement[]; + /** + * Selects the methods to which this rule applies. Refer to selector for + * syntax details. + */ + selector?: string; + } + /** + * Configuration of authorization. This section determines the authorization + * provider, if unspecified, then no authorization check will be done. + * Example: experimental: authorization: provider: + * firebaserules.googleapis.com + */ + export interface Schema$AuthorizationConfig { + /** + * The name of the authorization provider, such as + * firebaserules.googleapis.com. + */ + provider?: string; + } + /** + * Authorization rule for API services. It specifies the permission(s) + * required for an API element for the overall API request to succeed. It is + * typically used to mark request message fields that contain the name of the + * resource and indicates the permissions that will be checked on that + * resource. For example: package google.storage.v1; message + * CopyObjectRequest { string source = 1 [ + * (google.api.authz).permissions = "storage.objects.get"]; string + * destination = 2 [ (google.api.authz).permissions = + * "storage.objects.create,storage.objects.update"]; } + */ + export interface Schema$AuthorizationRule { + /** + * The required permissions. The acceptable values vary depend on the + * authorization system used. For Google APIs, it should be a + * comma-separated Google IAM permission values. When multiple permissions + * are listed, the semantics is not defined by the system. Additional + * documentation must be provided manually. + */ + permissions?: string; + /** + * Selects the API elements to which this rule applies. Refer to selector + * for syntax details. + */ + selector?: string; + } + /** + * Configuration for an anthentication provider, including support for [JSON + * Web Token + * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + */ + export interface Schema$AuthProvider { + /** + * The list of JWT + * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + * that are allowed to access. A JWT containing any of these audiences will + * be accepted. When this setting is absent, only JWTs with audience + * "https://Service_name/API_name" will be accepted. For example, + * if no audiences are in the setting, LibraryService API will only accept + * JWTs with the following audience + * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + * Example: audiences: bookstore_android.apps.googleusercontent.com, + * bookstore_web.apps.googleusercontent.com + */ + audiences?: string; + /** + * Redirect URL if JWT token is required but no present or is expired. + * Implement authorizationUrl of securityDefinitions in OpenAPI spec. + */ + authorizationUrl?: string; + /** + * The unique identifier of the auth provider. It will be referred to by + * `AuthRequirement.provider_id`. Example: "bookstore_auth". + */ + id?: string; + /** + * Identifies the principal that issued the JWT. See + * https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + * Usually a URL or an email address. Example: + * https://securetoken.google.com Example: + * 1234567-compute@developer.gserviceaccount.com + */ + issuer?: string; + /** + * URL of the provider's public key set to validate signature of the + * JWT. See [OpenID + * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + * Optional if the key set document: - can be retrieved from [OpenID + * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of + * the issuer. - can be inferred from the email domain of the issuer (e.g. + * a Google service account). Example: + * https://www.googleapis.com/oauth2/v1/certs + */ + jwksUri?: string; + } + /** + * User-defined authentication requirements, including support for [JSON Web + * Token + * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + */ + export interface Schema$AuthRequirement { + /** + * NOTE: This will be deprecated soon, once AuthProvider.audiences is + * implemented and accepted in all the runtime components. The list of JWT + * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + * that are allowed to access. A JWT containing any of these audiences will + * be accepted. When this setting is absent, only JWTs with audience + * "https://Service_name/API_name" will be accepted. For example, + * if no audiences are in the setting, LibraryService API will only accept + * JWTs with the following audience + * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + * Example: audiences: bookstore_android.apps.googleusercontent.com, + * bookstore_web.apps.googleusercontent.com + */ + audiences?: string; + /** + * id from authentication provider. Example: provider_id: + * bookstore_auth + */ + providerId?: string; + } + /** + * `Backend` defines the backend configuration for a service. + */ + export interface Schema$Backend { + /** + * A list of API backend rules that apply to individual API methods. + * **NOTE:** All service configuration rules follow "last one + * wins" order. + */ + rules?: Schema$BackendRule[]; + } + /** + * A backend rule provides configuration for an individual API element. + */ + export interface Schema$BackendRule { + /** + * The address of the API backend. + */ + address?: string; + /** + * The number of seconds to wait for a response from a request. The default + * deadline for gRPC is infinite (no deadline) and HTTP requests is 5 + * seconds. + */ + deadline?: number; + /** + * Minimum deadline in seconds needed for this method. Calls having deadline + * value lower than this will be rejected. + */ + minDeadline?: number; + /** + * Selects the methods to which this rule applies. Refer to selector for + * syntax details. + */ + selector?: string; + } + /** + * Request message for the `BatchEnableServices` method. + */ + export interface Schema$BatchEnableServicesRequest { + /** + * The identifiers of the services to enable on the project. A valid + * identifier would be: serviceusage.googleapis.com Enabling services + * requires that each service is public or is shared with the user enabling + * the service. Two or more services must be specified. To enable a single + * service, use the `EnableService` method instead. A single request can + * enable a maximum of 20 services at a time. If more than 20 services are + * specified, the request will fail, and no state changes will occur. + */ + serviceIds?: string[]; + } + /** + * Response message for the `BatchEnableServices` method. This response + * message is assigned to the `response` field of the returned Operation when + * that operation is done. + */ + export interface Schema$BatchEnableServicesResponse { + /** + * If allow_partial_success is true, and one or more services could not be + * enabled, this field contains the details about each failure. + */ + failures?: Schema$EnableFailure[]; + /** + * The new state of the services after enabling. + */ + services?: Schema$GoogleApiServiceusageV1Service[]; + } + /** + * Billing related configuration of the service. The following example shows + * how to configure monitored resources and metrics for billing: + * monitored_resources: - type: library.googleapis.com/branch labels: - + * key: /city description: The city where the library branch is + * located in. - key: /name description: The name of the branch. + * metrics: - name: library.googleapis.com/book/borrowed_count + * metric_kind: DELTA value_type: INT64 billing: + * consumer_destinations: - monitored_resource: + * library.googleapis.com/branch metrics: - + * library.googleapis.com/book/borrowed_count + */ + export interface Schema$Billing { + /** + * Billing configurations for sending metrics to the consumer project. There + * can be multiple consumer destinations per service, each one must have a + * different monitored resource type. A metric can be used in at most one + * consumer destination. + */ + consumerDestinations?: Schema$BillingDestination[]; + } + /** + * Configuration of a specific billing destination (Currently only support + * bill against consumer project). + */ + export interface Schema$BillingDestination { + /** + * Names of the metrics to report to this billing destination. Each name + * must be defined in Service.metrics section. + */ + metrics?: string[]; + /** + * The monitored resource type. The type must be defined in + * Service.monitored_resources section. + */ + monitoredResource?: string; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * `Context` defines which contexts an API requests. Example: context: + * rules: - selector: "*" requested: - + * google.rpc.context.ProjectContext - + * google.rpc.context.OriginContext The above specifies that all methods in + * the API request `google.rpc.context.ProjectContext` and + * `google.rpc.context.OriginContext`. Available context types are defined in + * package `google.rpc.context`. This also provides mechanism to whitelist + * any protobuf message extension that can be sent in grpc metadata using + * “x-goog-ext-<extension_id>-bin” and + * “x-goog-ext-<extension_id>-jspb” format. For example, list any + * service specific protobuf types that can appear in grpc metadata as follows + * in your yaml file: Example: context: rules: - selector: + * "google.example.library.v1.LibraryService.CreateBook" + * allowed_request_extensions: - google.foo.v1.NewExtension + * allowed_response_extensions: - google.foo.v1.NewExtension You can + * also specify extension ID instead of fully qualified extension name here. + */ + export interface Schema$Context { + /** + * A list of RPC context rules that apply to individual API methods. + * **NOTE:** All service configuration rules follow "last one + * wins" order. + */ + rules?: Schema$ContextRule[]; + } + /** + * A context rule provides information about the context for an individual API + * element. + */ + export interface Schema$ContextRule { + /** + * A list of full type names or extension IDs of extensions allowed in grpc + * side channel from client to backend. + */ + allowedRequestExtensions?: string[]; + /** + * A list of full type names or extension IDs of extensions allowed in grpc + * side channel from backend to client. + */ + allowedResponseExtensions?: string[]; + /** + * A list of full type names of provided contexts. + */ + provided?: string[]; + /** + * A list of full type names of requested contexts. + */ + requested?: string[]; + /** + * Selects the methods to which this rule applies. Refer to selector for + * syntax details. + */ + selector?: string; + } + /** + * Selects and configures the service controller used by the service. The + * service controller handles features like abuse, quota, billing, logging, + * monitoring, etc. + */ + export interface Schema$Control { + /** + * The service control environment to use. If empty, no control plane + * feature (like quota and billing) will be enabled. + */ + environment?: string; + } + /** + * Customize service error responses. For example, list any service specific + * protobuf types that can appear in error detail lists of error responses. + * Example: custom_error: types: - google.foo.v1.CustomError + * - google.foo.v1.AnotherError + */ + export interface Schema$CustomError { + /** + * The list of custom error rules that apply to individual API messages. + * **NOTE:** All service configuration rules follow "last one + * wins" order. + */ + rules?: Schema$CustomErrorRule[]; + /** + * The list of custom error detail types, e.g. + * 'google.foo.v1.CustomError'. + */ + types?: string[]; + } + /** + * A custom error rule. + */ + export interface Schema$CustomErrorRule { + /** + * Mark this message as possible payload in error response. Otherwise, + * objects of this type will be filtered when they appear in error payload. + */ + isErrorType?: boolean; + /** + * Selects messages to which this rule applies. Refer to selector for + * syntax details. + */ + selector?: string; + } + /** + * A custom pattern is used for defining custom HTTP verb. + */ + export interface Schema$CustomHttpPattern { + /** + * The name of this custom HTTP verb. + */ + kind?: string; + /** + * The path matched by this custom verb. + */ + path?: string; + } + /** + * Request message for the `DisableService` method. + */ + export interface Schema$DisableServiceRequest { + /** + * Indicates if services that are enabled and which depend on this service + * should also be disabled. If not set, an error will be generated if any + * enabled services depend on the service to be disabled. When set, the + * service, and any enabled services that depend on it, will be disabled + * together. + */ + disableDependentServices?: boolean; + } + /** + * Response message for the `DisableService` method. This response message is + * assigned to the `response` field of the returned Operation when that + * operation is done. + */ + export interface Schema$DisableServiceResponse { + /** + * The new state of the service after disabling. + */ + service?: Schema$GoogleApiServiceusageV1Service; + } + /** + * `Documentation` provides the information for describing a service. Example: + * <pre><code>documentation: summary: > The Google + * Calendar API gives access to most calendar features. pages: - name: + * Overview content: &#40;== include google/foo/overview.md + * ==&#41; - name: Tutorial content: &#40;== include + * google/foo/tutorial.md ==&#41; subpages; - name: Java content: + * &#40;== include google/foo/tutorial_java.md ==&#41; rules: - + * selector: google.calendar.Calendar.Get description: > ... - + * selector: google.calendar.Calendar.Put description: > ... + * </code></pre> Documentation is provided in markdown syntax. In + * addition to standard markdown features, definition lists, tables and fenced + * code blocks are supported. Section headers can be provided and are + * interpreted relative to the section nesting of the context where a + * documentation fragment is embedded. Documentation from the IDL is merged + * with documentation defined via the config at normalization time, where + * documentation provided by config rules overrides IDL provided. A number of + * constructs specific to the API platform are supported in documentation + * text. In order to reference a proto element, the following notation can be + * used: + * <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> + * To override the display text used for the link, this can be used: + * <pre><code>&#91;display + * text]&#91;fully.qualified.proto.name]</code></pre> Text can + * be excluded from doc using the following notation: + * <pre><code>&#40;-- internal comment + * --&#41;</code></pre> A few directives are available in + * documentation. Note that directives must appear on a single line to be + * properly identified. The `include` directive includes a markdown file from + * an external source: <pre><code>&#40;== include path/to/file + * ==&#41;</code></pre> The `resource_for` directive marks a + * message to be the resource of a collection in REST view. If it is not + * specified, tools attempt to infer the resource from the operations in a + * collection: <pre><code>&#40;== resource_for + * v1.shelves.books ==&#41;</code></pre> The directive + * `suppress_warning` does not directly affect documentation and is documented + * together with service config validation. + */ + export interface Schema$Documentation { + /** + * The URL to the root of documentation. + */ + documentationRootUrl?: string; + /** + * Declares a single overview page. For example: + * <pre><code>documentation: summary: ... overview: + * &#40;== include overview.md ==&#41; </code></pre> + * This is a shortcut for the following declaration (using pages style): + * <pre><code>documentation: summary: ... pages: - name: + * Overview content: &#40;== include overview.md ==&#41; + * </code></pre> Note: you cannot specify both `overview` field + * and `pages` field. + */ + overview?: string; + /** + * The top level pages for the documentation set. + */ + pages?: Schema$Page[]; + /** + * A list of documentation rules that apply to individual API elements. + * **NOTE:** All service configuration rules follow "last one + * wins" order. + */ + rules?: Schema$DocumentationRule[]; + /** + * A short summary of what the service does. Can only be provided by plain + * text. + */ + summary?: string; + } + /** + * A documentation rule provides information about individual API elements. + */ + export interface Schema$DocumentationRule { + /** + * Deprecation description of the selected element(s). It can be provided if + * an element is marked as `deprecated`. + */ + deprecationDescription?: string; + /** + * Description of the selected API(s). + */ + description?: string; + /** + * The selector is a comma-separated list of patterns. Each pattern is a + * qualified name of the element which may end in "*", indicating + * a wildcard. Wildcards are only allowed at the end and for a whole + * component of the qualified name, i.e. "foo.*" is ok, but not + * "foo.b*" or "foo.*.bar". To specify a default for all + * applicable elements, the whole pattern "*" is used. + */ + selector?: string; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated + * empty messages in your APIs. A typical example is to use it as the request + * or the response type of an API method. For instance: service Foo { rpc + * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON + * representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} + /** + * Provides error messages for the failing services. + */ + export interface Schema$EnableFailure { + /** + * An error message describing why the service could not be enabled. + */ + errorMessage?: string; + /** + * The service id of a service that could not be enabled. + */ + serviceId?: string; + } + /** + * Request message for the `EnableService` method. + */ + export interface Schema$EnableServiceRequest {} + /** + * Response message for the `EnableService` method. This response message is + * assigned to the `response` field of the returned Operation when that + * operation is done. + */ + export interface Schema$EnableServiceResponse { + /** + * The new state of the service after enabling. + */ + service?: Schema$GoogleApiServiceusageV1Service; + } + /** + * `Endpoint` describes a network endpoint that serves a set of APIs. A + * service may expose any number of endpoints, and all endpoints share the + * same service configuration, such as quota configuration and monitoring + * configuration. Example service configuration: name: + * library-example.googleapis.com endpoints: # Below entry makes + * 'google.example.library.v1.Library' # API be served from + * endpoint address library-example.googleapis.com. # It also allows + * HTTP OPTIONS calls to be passed to the backend, for # it to decide + * whether the subsequent cross-origin request is # allowed to proceed. + * - name: library-example.googleapis.com allow_cors: true + */ + export interface Schema$Endpoint { + /** + * DEPRECATED: This field is no longer supported. Instead of using aliases, + * please specify multiple google.api.Endpoint for each of the intended + * aliases. Additional names that this endpoint will be hosted on. + */ + aliases?: string[]; + /** + * Allowing + * [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka + * cross-domain traffic, would allow the backends served from this endpoint + * to receive and respond to HTTP OPTIONS requests. The response will be + * used by the browser to determine whether the subsequent cross-origin + * request is allowed to proceed. + */ + allowCors?: boolean; + /** + * The list of features enabled on this endpoint. + */ + features?: string[]; + /** + * The canonical name of this endpoint. + */ + name?: string; + /** + * The specification of an Internet routable address of API frontend that + * will handle requests to this [API + * Endpoint](https://cloud.google.com/apis/design/glossary). It should be + * either a valid IPv4 address or a fully-qualified domain name. For + * example, "8.8.8.8" or "myservice.appspot.com". + */ + target?: string; + } + /** + * Enum type definition. + */ + export interface Schema$Enum { + /** + * Enum value definitions. + */ + enumvalue?: Schema$EnumValue[]; + /** + * Enum type name. + */ + name?: string; + /** + * Protocol buffer options. + */ + options?: Schema$Option[]; + /** + * The source context. + */ + sourceContext?: Schema$SourceContext; + /** + * The source syntax. + */ + syntax?: string; + } + /** + * Enum value definition. + */ + export interface Schema$EnumValue { + /** + * Enum value name. + */ + name?: string; + /** + * Enum value number. + */ + number?: number; + /** + * Protocol buffer options. + */ + options?: Schema$Option[]; + } + /** + * Experimental service configuration. These configuration options can only be + * used by whitelisted users. + */ + export interface Schema$Experimental { + /** + * Authorization configuration. + */ + authorization?: Schema$AuthorizationConfig; + } + /** + * A single field of a message type. + */ + export interface Schema$Field { + /** + * The field cardinality. + */ + cardinality?: string; + /** + * The string value of the default value of this field. Proto2 syntax only. + */ + defaultValue?: string; + /** + * The field JSON name. + */ + jsonName?: string; + /** + * The field type. + */ + kind?: string; + /** + * The field name. + */ + name?: string; + /** + * The field number. + */ + number?: number; + /** + * The index of the field type in `Type.oneofs`, for message or enumeration + * types. The first type has index 1; zero means the type is not in the + * list. + */ + oneofIndex?: number; + /** + * The protocol buffer options. + */ + options?: Schema$Option[]; + /** + * Whether to use alternative packed wire representation. + */ + packed?: boolean; + /** + * The field type URL, without the scheme, for message or enumeration types. + * Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + */ + typeUrl?: string; + } + /** + * `Service` is the root object of Google service configuration schema. It + * describes basic information about a service, such as the name and the + * title, and delegates other aspects to sub-sections. Each sub-section is + * either a proto message or a repeated proto message that configures a + * specific aspect, such as auth. See each proto message definition for + * details. Example: type: google.api.Service config_version: 3 + * name: calendar.googleapis.com title: Google Calendar API apis: - + * name: google.calendar.v3.Calendar authentication: providers: - + * id: google_calendar_auth jwks_uri: + * https://www.googleapis.com/oauth2/v1/certs issuer: + * https://securetoken.google.com rules: - selector: "*" + * requirements: provider_id: google_calendar_auth + */ + export interface Schema$GoogleApiService { + /** + * A list of API interfaces exported by this service. Only the `name` field + * of the google.protobuf.Api needs to be provided by the configuration + * author, as the remaining fields will be derived from the IDL during the + * normalization process. It is an error to specify an API interface here + * which cannot be resolved against the associated IDL files. + */ + apis?: Schema$Api[]; + /** + * Auth configuration. + */ + authentication?: Schema$Authentication; + /** + * API backend configuration. + */ + backend?: Schema$Backend; + /** + * Billing configuration. + */ + billing?: Schema$Billing; + /** + * The semantic version of the service configuration. The config version + * affects the interpretation of the service configuration. For example, + * certain features are enabled by default for certain config versions. The + * latest config version is `3`. + */ + configVersion?: number; + /** + * Context configuration. + */ + context?: Schema$Context; + /** + * Configuration for the service control plane. + */ + control?: Schema$Control; + /** + * Custom error configuration. + */ + customError?: Schema$CustomError; + /** + * Additional API documentation. + */ + documentation?: Schema$Documentation; + /** + * Configuration for network endpoints. If this is empty, then an endpoint + * with the same name as the service is automatically generated to service + * all defined APIs. + */ + endpoints?: Schema$Endpoint[]; + /** + * A list of all enum types included in this API service. Enums referenced + * directly or indirectly by the `apis` are automatically included. Enums + * which are not referenced but shall be included should be listed here by + * name. Example: enums: - name: google.someapi.v1.SomeEnum + */ + enums?: Schema$Enum[]; + /** + * Experimental configuration. + */ + experimental?: Schema$Experimental; + /** + * HTTP configuration. + */ + http?: Schema$Http; + /** + * A unique ID for a specific instance of this message, typically assigned + * by the client for tracking purpose. If empty, the server may choose to + * generate one instead. + */ + id?: string; + /** + * Logging configuration. + */ + logging?: Schema$Logging; + /** + * Defines the logs used by this service. + */ + logs?: Schema$LogDescriptor[]; + /** + * Defines the metrics used by this service. + */ + metrics?: Schema$MetricDescriptor[]; + /** + * Defines the monitored resources used by this service. This is required by + * the Service.monitoring and Service.logging configurations. + */ + monitoredResources?: Schema$MonitoredResourceDescriptor[]; + /** + * Monitoring configuration. + */ + monitoring?: Schema$Monitoring; + /** + * The DNS address at which this service is available, e.g. + * `calendar.googleapis.com`. + */ + name?: string; + /** + * The Google project that owns this service. + */ + producerProjectId?: string; + /** + * Quota configuration. + */ + quota?: Schema$Quota; + /** + * Output only. The source information for this configuration if available. + */ + sourceInfo?: Schema$SourceInfo; + /** + * System parameter configuration. + */ + systemParameters?: Schema$SystemParameters; + /** + * A list of all proto message types included in this API service. It serves + * similar purpose as [google.api.Service.types], except that these types + * are not needed by user-defined APIs. Therefore, they will not show up in + * the generated discovery doc. This field should only be used to define + * system APIs in ESF. + */ + systemTypes?: Schema$Type[]; + /** + * The product title for this service. + */ + title?: string; + /** + * A list of all proto message types included in this API service. Types + * referenced directly or indirectly by the `apis` are automatically + * included. Messages which are not referenced but shall be included, such + * as types used by the `google.protobuf.Any` type, should be listed here by + * name. Example: types: - name: google.protobuf.Int32 + */ + types?: Schema$Type[]; + /** + * Configuration controlling usage of this service. + */ + usage?: Schema$Usage; + } + /** + * The operation metadata returned for the batchend services operation. + */ + export interface Schema$GoogleApiServiceusageV1OperationMetadata { + /** + * The full name of the resources that this operation is directly associated + * with. + */ + resourceNames?: string[]; + } + /** + * A service that is available for use by the consumer. + */ + export interface Schema$GoogleApiServiceusageV1Service { + /** + * The service configuration of the available service. Some fields may be + * filtered out of the configuration in responses to the `ListServices` + * method. These fields are present only in responses to the `GetService` + * method. + */ + config?: Schema$GoogleApiServiceusageV1ServiceConfig; + /** + * The resource name of the consumer and service. A valid name would be: - + * projects/123/services/serviceusage.googleapis.com + */ + name?: string; + /** + * The resource name of the consumer. A valid name would be: - projects/123 + */ + parent?: string; + /** + * Whether or not the service has been enabled for use by the consumer. + */ + state?: string; + } + /** + * The configuration of the service. + */ + export interface Schema$GoogleApiServiceusageV1ServiceConfig { + /** + * A list of API interfaces exported by this service. Contains only the + * names, versions, and method names of the interfaces. + */ + apis?: Schema$Api[]; + /** + * Auth configuration. Contains only the OAuth rules. + */ + authentication?: Schema$Authentication; + /** + * Additional API documentation. Contains only the summary and the + * documentation URL. + */ + documentation?: Schema$Documentation; + /** + * Configuration for network endpoints. Contains only the names and aliases + * of the endpoints. + */ + endpoints?: Schema$Endpoint[]; + /** + * The DNS address at which this service is available. An example DNS + * address would be: `calendar.googleapis.com`. + */ + name?: string; + /** + * Quota configuration. + */ + quota?: Schema$Quota; + /** + * The product title for this service. + */ + title?: string; + /** + * Configuration controlling usage of this service. + */ + usage?: Schema$Usage; + } + /** + * Defines the HTTP configuration for an API service. It contains a list of + * HttpRule, each specifying the mapping of an RPC method to one or more HTTP + * REST API methods. + */ + export interface Schema$Http { + /** + * When set to true, URL path parmeters will be fully URI-decoded except in + * cases of single segment matches in reserved expansion, where + * "%2F" will be left encoded. The default behavior is to not + * decode RFC 6570 reserved characters in multi segment matches. + */ + fullyDecodeReservedExpansion?: boolean; + /** + * A list of HTTP configuration rules that apply to individual API methods. + * **NOTE:** All service configuration rules follow "last one + * wins" order. + */ + rules?: Schema$HttpRule[]; + } + /** + * `HttpRule` defines the mapping of an RPC method to one or more HTTP REST + * API methods. The mapping specifies how different portions of the RPC + * request message are mapped to URL path, URL query parameters, and HTTP + * request body. The mapping is typically specified as an `google.api.http` + * annotation on the RPC method, see "google/api/annotations.proto" + * for details. The mapping consists of a field specifying the path template + * and method kind. The path template can refer to fields in the request + * message, as in the example below which describes a REST GET operation on a + * resource collection of messages: service Messaging { rpc + * GetMessage(GetMessageRequest) returns (Message) { option + * (google.api.http).get = + * "/v1/messages/{message_id}/{sub.subfield}"; } } message + * GetMessageRequest { message SubMessage { string subfield = 1; + * } string message_id = 1; // mapped to the URL SubMessage sub = + * 2; // `sub.subfield` is url-mapped } message Message { string + * text = 1; // content of the resource } The same http annotation can + * alternatively be expressed inside the `GRPC API Configuration` YAML file. + * http: rules: - selector: + * <proto_package_name>.Messaging.GetMessage get: + * /v1/messages/{message_id}/{sub.subfield} This definition enables an + * automatic, bidrectional mapping of HTTP JSON to RPC. Example: HTTP | RPC + * -----|----- `GET /v1/messages/123456/foo` | `GetMessage(message_id: + * "123456" sub: SubMessage(subfield: "foo"))` In + * general, not only fields but also field paths can be referenced from a path + * pattern. Fields mapped to the path pattern cannot be repeated and must have + * a primitive (non-message) type. Any fields in the request message which + * are not bound by the path pattern automatically become (optional) HTTP + * query parameters. Assume the following definition of the request message: + * service Messaging { rpc GetMessage(GetMessageRequest) returns + * (Message) { option (google.api.http).get = + * "/v1/messages/{message_id}"; } } message + * GetMessageRequest { message SubMessage { string subfield = 1; + * } string message_id = 1; // mapped to the URL int64 revision = + * 2; // becomes a parameter SubMessage sub = 3; // `sub.subfield` + * becomes a parameter } This enables a HTTP JSON to RPC mapping as + * below: HTTP | RPC -----|----- `GET + * /v1/messages/123456?revision=2&sub.subfield=foo` | + * `GetMessage(message_id: "123456" revision: 2 sub: + * SubMessage(subfield: "foo"))` Note that fields which are mapped + * to HTTP parameters must have a primitive type or a repeated primitive type. + * Message types are not allowed. In the case of a repeated type, the + * parameter can be repeated in the URL, as in `...?param=A&param=B`. For + * HTTP method kinds which allow a request body, the `body` field specifies + * the mapping. Consider a REST update method on the message resource + * collection: service Messaging { rpc + * UpdateMessage(UpdateMessageRequest) returns (Message) { option + * (google.api.http) = { put: "/v1/messages/{message_id}" + * body: "message" }; } } message + * UpdateMessageRequest { string message_id = 1; // mapped to the URL + * Message message = 2; // mapped to the body } The following HTTP + * JSON to RPC mapping is enabled, where the representation of the JSON in the + * request body is determined by protos JSON encoding: HTTP | RPC -----|----- + * `PUT /v1/messages/123456 { "text": "Hi!" }` | + * `UpdateMessage(message_id: "123456" message { text: + * "Hi!" })` The special name `*` can be used in the body mapping + * to define that every field not bound by the path template should be mapped + * to the request body. This enables the following alternative definition of + * the update method: service Messaging { rpc + * UpdateMessage(Message) returns (Message) { option (google.api.http) + * = { put: "/v1/messages/{message_id}" body: + * "*" }; } } message Message { string + * message_id = 1; string text = 2; } The following HTTP JSON to + * RPC mapping is enabled: HTTP | RPC -----|----- `PUT /v1/messages/123456 { + * "text": "Hi!" }` | `UpdateMessage(message_id: + * "123456" text: "Hi!")` Note that when using `*` in the + * body mapping, it is not possible to have HTTP parameters, as all fields not + * bound by the path end in the body. This makes this option more rarely used + * in practice of defining REST APIs. The common usage of `*` is in custom + * methods which don't use the URL at all for transferring data. It is + * possible to define multiple HTTP methods for one RPC by using the + * `additional_bindings` option. Example: service Messaging { rpc + * GetMessage(GetMessageRequest) returns (Message) { option + * (google.api.http) = { get: "/v1/messages/{message_id}" + * additional_bindings { get: + * "/v1/users/{user_id}/messages/{message_id}" } }; } } + * message GetMessageRequest { string message_id = 1; string + * user_id = 2; } This enables the following two alternative HTTP JSON + * to RPC mappings: HTTP | RPC -----|----- `GET /v1/messages/123456` | + * `GetMessage(message_id: "123456")` `GET + * /v1/users/me/messages/123456` | `GetMessage(user_id: "me" + * message_id: "123456")` # Rules for HTTP mapping The rules for + * mapping HTTP path, query parameters, and body fields to the request message + * are as follows: 1. The `body` field specifies either `*` or a field path, + * or is omitted. If omitted, it indicates there is no HTTP request + * body. 2. Leaf fields (recursive expansion of nested messages in the + * request) can be classified into three types: (a) Matched in the URL + * template. (b) Covered by body (if body is `*`, everything except (a) + * fields; else everything under the body field) (c) All other + * fields. 3. URL query parameters found in the HTTP request are mapped to (c) + * fields. 4. Any body sent with an HTTP request can contain only (b) fields. + * The syntax of the path template is as follows: Template = + * "/" Segments [ Verb ] ; Segments = Segment { "/" + * Segment } ; Segment = "*" | "**" | LITERAL | + * Variable ; Variable = "{" FieldPath [ "=" Segments + * ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb + * = ":" LITERAL ; The syntax `*` matches a single path segment. + * The syntax `**` matches zero or more path segments, which must be the last + * part of the path except the `Verb`. The syntax `LITERAL` matches literal + * text in the path. The syntax `Variable` matches part of the URL path as + * specified by its template. A variable template must not contain other + * variables. If a variable matches a single path segment, its template may be + * omitted, e.g. `{var}` is equivalent to `{var=*}`. If a variable contains + * exactly one path segment, such as `"{var}"` or + * `"{var=*}"`, when such a variable is expanded into a URL path, + * all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables + * show up in the Discovery Document as `{var}`. If a variable contains one + * or more path segments, such as `"{var=foo/*}"` or + * `"{var=**}"`, when such a variable is expanded into a URL path, + * all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such + * variables show up in the Discovery Document as `{+var}`. NOTE: While the + * single segment variable matches the semantics of [RFC + * 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + * Expansion, the multi segment variable **does not** match RFC 6570 Reserved + * Expansion. The reason is that the Reserved Expansion does not expand + * special characters like `?` and `#`, which would lead to invalid URLs. + * NOTE: the field paths in variables and in the `body` must not refer to + * repeated fields or map fields. + */ + export interface Schema$HttpRule { + /** + * Additional HTTP bindings for the selector. Nested bindings must not + * contain an `additional_bindings` field themselves (that is, the nesting + * may only be one level deep). + */ + additionalBindings?: Schema$HttpRule[]; + /** + * Specifies the permission(s) required for an API element for the overall + * API request to succeed. It is typically used to mark request message + * fields that contain the name of the resource and indicates the + * permissions that will be checked on that resource. + */ + authorizations?: Schema$AuthorizationRule[]; + /** + * The name of the request field whose value is mapped to the HTTP body, or + * `*` for mapping all fields not captured by the path pattern to the HTTP + * body. NOTE: the referred field must not be a repeated field and must be + * present at the top-level of request message type. + */ + body?: string; + /** + * The custom pattern is used for specifying an HTTP method that is not + * included in the `pattern` field, such as HEAD, or "*" to leave + * the HTTP method unspecified for this rule. The wild-card rule is useful + * for services that provide content to Web (HTML) clients. + */ + custom?: Schema$CustomHttpPattern; + /** + * Used for deleting a resource. + */ + delete?: string; + /** + * Used for listing and getting information about resources. + */ + get?: string; + /** + * Use this only for Scotty Requests. Do not use this for bytestream + * methods. For media support, add instead + * [][google.bytestream.RestByteStream] as an API to your configuration. + */ + mediaDownload?: Schema$MediaDownload; + /** + * Use this only for Scotty Requests. Do not use this for media support + * using Bytestream, add instead [][google.bytestream.RestByteStream] as an + * API to your configuration for Bytestream methods. + */ + mediaUpload?: Schema$MediaUpload; + /** + * Used for updating a resource. + */ + patch?: string; + /** + * Used for creating a resource. + */ + post?: string; + /** + * Used for updating a resource. + */ + put?: string; + /** + * DO NOT USE. This is an experimental field. Optional. The REST collection + * name is by default derived from the URL pattern. If specified, this field + * overrides the default collection name. Example: rpc + * AddressesAggregatedList(AddressesAggregatedListRequest) returns + * (AddressesAggregatedListResponse) { option (google.api.http) = { + * get: "/v1/projects/{project_id}/aggregated/addresses" + * rest_collection: "projects.addresses" }; } This + * method has the automatically derived collection name + * "projects.aggregated". Because, semantically, this rpc is + * actually an operation on the "projects.addresses" collection, + * the `rest_collection` field is configured to override the derived + * collection name. + */ + restCollection?: string; + /** + * DO NOT USE. This is an experimental field. Optional. The rest method + * name is by default derived from the URL pattern. If specified, this field + * overrides the default method name. Example: rpc + * CreateResource(CreateResourceRequest) returns + * (CreateResourceResponse) { option (google.api.http) = { post: + * "/v1/resources", body: "resource", + * rest_method_name: "insert" }; } This method has the + * automatically derived rest method name "create", but for + * backwards compatibility with apiary, it is specified as insert. + */ + restMethodName?: string; + /** + * Selects methods to which this rule applies. Refer to selector for syntax + * details. + */ + selector?: string; + } + /** + * A description of a label. + */ + export interface Schema$LabelDescriptor { + /** + * A human-readable description for the label. + */ + description?: string; + /** + * The label key. + */ + key?: string; + /** + * The type of data that can be assigned to the label. + */ + valueType?: string; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * Response message for the `ListServices` method. + */ + export interface Schema$ListServicesResponse { + /** + * Token that can be passed to `ListServices` to resume a paginated query. + */ + nextPageToken?: string; + /** + * The available services for the requested project. + */ + services?: Schema$GoogleApiServiceusageV1Service[]; + } + /** + * A description of a log type. Example in YAML format: - name: + * library.googleapis.com/activity_history description: The history of + * borrowing and returning library items. display_name: Activity labels: + * - key: /customer_id description: Identifier of a library customer + */ + export interface Schema$LogDescriptor { + /** + * A human-readable description of this log. This information appears in the + * documentation and can contain details. + */ + description?: string; + /** + * The human-readable name for this log. This information appears on the + * user interface and should be concise. + */ + displayName?: string; + /** + * The set of labels that are available to describe a specific log entry. + * Runtime requests that contain labels not specified here are considered + * invalid. + */ + labels?: Schema$LabelDescriptor[]; + /** + * The name of the log. It must be less than 512 characters long and can + * include the following characters: upper- and lower-case alphanumeric + * characters [A-Za-z0-9], and punctuation characters including slash, + * underscore, hyphen, period [/_-.]. + */ + name?: string; + } + /** + * Logging configuration of the service. The following example shows how to + * configure logs to be sent to the producer and consumer projects. In the + * example, the `activity_history` log is sent to both the producer and + * consumer projects, whereas the `purchase_history` log is only sent to the + * producer project. monitored_resources: - type: + * library.googleapis.com/branch labels: - key: /city description: + * The city where the library branch is located in. - key: /name + * description: The name of the branch. logs: - name: activity_history + * labels: - key: /customer_id - name: purchase_history logging: + * producer_destinations: - monitored_resource: + * library.googleapis.com/branch logs: - activity_history - + * purchase_history consumer_destinations: - monitored_resource: + * library.googleapis.com/branch logs: - activity_history + */ + export interface Schema$Logging { + /** + * Logging configurations for sending logs to the consumer project. There + * can be multiple consumer destinations, each one must have a different + * monitored resource type. A log can be used in at most one consumer + * destination. + */ + consumerDestinations?: Schema$LoggingDestination[]; + /** + * Logging configurations for sending logs to the producer project. There + * can be multiple producer destinations, each one must have a different + * monitored resource type. A log can be used in at most one producer + * destination. + */ + producerDestinations?: Schema$LoggingDestination[]; + } + /** + * Configuration of a specific logging destination (the producer project or + * the consumer project). + */ + export interface Schema$LoggingDestination { + /** + * Names of the logs to be sent to this destination. Each name must be + * defined in the Service.logs section. If the log name is not a domain + * scoped name, it will be automatically prefixed with the service name + * followed by "/". + */ + logs?: string[]; + /** + * The monitored resource type. The type must be defined in the + * Service.monitored_resources section. + */ + monitoredResource?: string; + } + /** + * Defines the Media configuration for a service in case of a download. Use + * this only for Scotty Requests. Do not use this for media support using + * Bytestream, add instead [][google.bytestream.RestByteStream] as an API to + * your configuration for Bytestream methods. + */ + export interface Schema$MediaDownload { + /** + * A boolean that determines whether a notification for the completion of a + * download should be sent to the backend. + */ + completeNotification?: boolean; + /** + * DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED. Specify + * name of the download service if one is used for download. + */ + downloadService?: string; + /** + * Name of the Scotty dropzone to use for the current API. + */ + dropzone?: string; + /** + * Whether download is enabled. + */ + enabled?: boolean; + /** + * Optional maximum acceptable size for direct download. The size is + * specified in bytes. + */ + maxDirectDownloadSize?: string; + /** + * A boolean that determines if direct download from ESF should be used for + * download of this media. + */ + useDirectDownload?: boolean; + } + /** + * Defines the Media configuration for a service in case of an upload. Use + * this only for Scotty Requests. Do not use this for media support using + * Bytestream, add instead [][google.bytestream.RestByteStream] as an API to + * your configuration for Bytestream methods. + */ + export interface Schema$MediaUpload { + /** + * A boolean that determines whether a notification for the completion of an + * upload should be sent to the backend. These notifications will not be + * seen by the client and will not consume quota. + */ + completeNotification?: boolean; + /** + * Name of the Scotty dropzone to use for the current API. + */ + dropzone?: string; + /** + * Whether upload is enabled. + */ + enabled?: boolean; + /** + * Optional maximum acceptable size for an upload. The size is specified in + * bytes. + */ + maxSize?: string; + /** + * An array of mimetype patterns. Esf will only accept uploads that match + * one of the given patterns. + */ + mimeTypes?: string[]; + /** + * Whether to receive a notification for progress changes of media upload. + */ + progressNotification?: boolean; + /** + * Whether to receive a notification on the start of media upload. + */ + startNotification?: boolean; + /** + * DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED. Specify + * name of the upload service if one is used for upload. + */ + uploadService?: string; + } + /** + * Method represents a method of an API interface. + */ + export interface Schema$Method { + /** + * The simple name of this method. + */ + name?: string; + /** + * Any metadata attached to the method. + */ + options?: Schema$Option[]; + /** + * If true, the request is streamed. + */ + requestStreaming?: boolean; + /** + * A URL of the input message type. + */ + requestTypeUrl?: string; + /** + * If true, the response is streamed. + */ + responseStreaming?: boolean; + /** + * The URL of the output message type. + */ + responseTypeUrl?: string; + /** + * The source syntax of this method. + */ + syntax?: string; + } + /** + * Defines a metric type and its schema. Once a metric descriptor is created, + * deleting or altering it stops data collection and makes the metric + * type's existing data unusable. + */ + export interface Schema$MetricDescriptor { + /** + * A detailed description of the metric, which can be used in documentation. + */ + description?: string; + /** + * A concise name for the metric, which can be displayed in user interfaces. + * Use sentence case without an ending period, for example "Request + * count". This field is optional but it is recommended to be set for + * any metrics associated with user-visible concepts, such as Quota. + */ + displayName?: string; + /** + * The set of labels that can be used to describe a specific instance of + * this metric type. For example, the + * `appengine.googleapis.com/http/server/response_latencies` metric type has + * a label for the HTTP response code, `response_code`, so you can look at + * latencies for successful responses or just for responses that failed. + */ + labels?: Schema$LabelDescriptor[]; + /** + * Optional. Metadata which can be used to guide usage of the metric. + */ + metadata?: Schema$MetricDescriptorMetadata; + /** + * Whether the metric records instantaneous values, changes to a value, etc. + * Some combinations of `metric_kind` and `value_type` might not be + * supported. + */ + metricKind?: string; + /** + * The resource name of the metric descriptor. + */ + name?: string; + /** + * The metric type, including its DNS name prefix. The type is not + * URL-encoded. All user-defined custom metric types have the DNS name + * `custom.googleapis.com`. Metric types should use a natural hierarchical + * grouping. For example: + * "custom.googleapis.com/invoice/paid/amount" + * "appengine.googleapis.com/http/server/response_latencies" + */ + type?: string; + /** + * The unit in which the metric value is reported. It is only applicable if + * the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported + * units are a subset of [The Unified Code for Units of + * Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units + * (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute + * * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo + * (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera + * (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` + * zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * + * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico + * (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` + * zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * + * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) + * **Grammar** The grammar also includes these connectors: * `/` division + * (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix + * operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression + * = Component { "." Component } { "/" Component } ; + * Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | + * Annotation | "1" ; Annotation + * = "{" NAME "}" ; Notes: * `Annotation` is just a + * comment if it follows a `UNIT` and is equivalent to `1` if it is used + * alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == + * By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not + * containing '{' or '}'. * `1` represents dimensionless + * value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, + * and annotates values giving a percentage. + */ + unit?: string; + /** + * Whether the measurement is an integer, a floating-point number, etc. Some + * combinations of `metric_kind` and `value_type` might not be supported. + */ + valueType?: string; + } + /** + * Additional annotations that can be used to guide the usage of a metric. + */ + export interface Schema$MetricDescriptorMetadata { + /** + * The delay of data points caused by ingestion. Data points older than this + * age are guaranteed to be ingested and available to be read, excluding + * data loss due to errors. + */ + ingestDelay?: string; + /** + * The launch stage of the metric definition. + */ + launchStage?: string; + /** + * The sampling period of metric data points. For metrics which are written + * periodically, consecutive data points are stored at this time interval, + * excluding data loss due to errors. Metrics with a higher granularity have + * a smaller sampling period. + */ + samplePeriod?: string; + } + /** + * Bind API methods to metrics. Binding a method to a metric causes that + * metric's configured quota behaviors to apply to the method call. + */ + export interface Schema$MetricRule { + /** + * Metrics to update when the selected methods are called, and the + * associated cost applied to each metric. The key of the map is the metric + * name, and the values are the amount increased for the metric against + * which the quota limits are defined. The value must not be negative. + */ + metricCosts?: any; + /** + * Selects the methods to which this rule applies. Refer to selector for + * syntax details. + */ + selector?: string; + } + /** + * Declares an API Interface to be included in this interface. The including + * interface must redeclare all the methods from the included interface, but + * documentation and options are inherited as follows: - If after comment and + * whitespace stripping, the documentation string of the redeclared method + * is empty, it will be inherited from the original method. - Each + * annotation belonging to the service config (http, visibility) which is + * not set in the redeclared method will be inherited. - If an http + * annotation is inherited, the path pattern will be modified as follows. + * Any version prefix will be replaced by the version of the including + * interface plus the root path if specified. Example of a simple mixin: + * package google.acl.v1; service AccessControl { // Get the + * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { + * option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } + * package google.storage.v2; service Storage { // rpc + * GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc + * GetData(GetDataRequest) returns (Data) { option + * (google.api.http).get = "/v2/{resource=**}"; } } + * Example of a mixin configuration: apis: - name: + * google.storage.v2.Storage mixins: - name: + * google.acl.v1.AccessControl The mixin construct implies that all methods + * in `AccessControl` are also declared with same name and request/response + * types in `Storage`. A documentation generator or annotation processor will + * see the effective `Storage.GetAcl` method after inherting documentation and + * annotations as follows: service Storage { // Get the underlying + * ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + * (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... + * } Note how the version in the path pattern changed from `v1` to `v2`. If + * the `root` field in the mixin is specified, it should be a relative path + * under which inherited HTTP paths are placed. Example: apis: - + * name: google.storage.v2.Storage mixins: - name: + * google.acl.v1.AccessControl root: acls This implies the following + * inherited HTTP annotation: service Storage { // Get the + * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { + * option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; + * } ... } + */ + export interface Schema$Mixin { + /** + * The fully qualified name of the interface which is included. + */ + name?: string; + /** + * If non-empty specifies a path under which inherited HTTP paths are + * rooted. + */ + root?: string; + } + /** + * An object that describes the schema of a MonitoredResource object using a + * type name and a set of labels. For example, the monitored resource + * descriptor for Google Compute Engine VM instances has a type of + * `"gce_instance"` and specifies the use of the labels + * `"instance_id"` and `"zone"` to identify particular VM + * instances. Different APIs can support different monitored resource types. + * APIs generally provide a `list` method that returns the monitored resource + * descriptors used by the API. + */ + export interface Schema$MonitoredResourceDescriptor { + /** + * Optional. A detailed description of the monitored resource type that + * might be used in documentation. + */ + description?: string; + /** + * Optional. A concise name for the monitored resource type that might be + * displayed in user interfaces. It should be a Title Cased Noun Phrase, + * without any article or other determiners. For example, `"Google + * Cloud SQL Database"`. + */ + displayName?: string; + /** + * Required. A set of labels used to describe instances of this monitored + * resource type. For example, an individual Google Cloud SQL database is + * identified by values for the labels `"database_id"` and + * `"zone"`. + */ + labels?: Schema$LabelDescriptor[]; + /** + * Optional. The resource name of the monitored resource descriptor: + * `"projects/{project_id}/monitoredResourceDescriptors/{type}"` + * where {type} is the value of the `type` field in this object and + * {project_id} is a project ID that provides API-specific context for + * accessing the type. APIs that do not use project information can use the + * resource name format `"monitoredResourceDescriptors/{type}"`. + */ + name?: string; + /** + * Required. The monitored resource type. For example, the type + * `"cloudsql_database"` represents databases in Google Cloud SQL. + * The maximum length of this value is 256 characters. + */ + type?: string; + } + /** + * Monitoring configuration of the service. The example below shows how to + * configure monitored resources and metrics for monitoring. In the example, a + * monitored resource and two metrics are defined. The + * `library.googleapis.com/book/returned_count` metric is sent to both + * producer and consumer projects, whereas the + * `library.googleapis.com/book/overdue_count` metric is only sent to the + * consumer project. monitored_resources: - type: + * library.googleapis.com/branch labels: - key: /city description: + * The city where the library branch is located in. - key: /name + * description: The name of the branch. metrics: - name: + * library.googleapis.com/book/returned_count metric_kind: DELTA + * value_type: INT64 labels: - key: /customer_id - name: + * library.googleapis.com/book/overdue_count metric_kind: GAUGE + * value_type: INT64 labels: - key: /customer_id monitoring: + * producer_destinations: - monitored_resource: + * library.googleapis.com/branch metrics: - + * library.googleapis.com/book/returned_count consumer_destinations: - + * monitored_resource: library.googleapis.com/branch metrics: - + * library.googleapis.com/book/returned_count - + * library.googleapis.com/book/overdue_count + */ + export interface Schema$Monitoring { + /** + * Monitoring configurations for sending metrics to the consumer project. + * There can be multiple consumer destinations, each one must have a + * different monitored resource type. A metric can be used in at most one + * consumer destination. + */ + consumerDestinations?: Schema$MonitoringDestination[]; + /** + * Monitoring configurations for sending metrics to the producer project. + * There can be multiple producer destinations, each one must have a + * different monitored resource type. A metric can be used in at most one + * producer destination. + */ + producerDestinations?: Schema$MonitoringDestination[]; + } + /** + * Configuration of a specific monitoring destination (the producer project or + * the consumer project). + */ + export interface Schema$MonitoringDestination { + /** + * Names of the metrics to report to this monitoring destination. Each name + * must be defined in Service.metrics section. + */ + metrics?: string[]; + /** + * The monitored resource type. The type must be defined in + * Service.monitored_resources section. + */ + monitoredResource?: string; + } + /** + * OAuth scopes are a way to define data and permissions on data. For example, + * there are scopes defined for "Read-only access to Google + * Calendar" and "Access to Cloud Platform". Users can consent + * to a scope for an application, giving it permission to access that data on + * their behalf. OAuth scope specifications should be fairly coarse grained; + * a user will need to see and understand the text description of what your + * scope means. In most cases: use one or at most two OAuth scopes for an + * entire family of products. If your product has multiple APIs, you should + * probably be sharing the OAuth scope across all of those APIs. When you + * need finer grained OAuth consent screens: talk with your product management + * about how developers will use them in practice. Please note that even + * though each of the canonical scopes is enough for a request to be accepted + * and passed to the backend, a request can still fail due to the backend + * requiring additional scopes or permissions. + */ + export interface Schema$OAuthRequirements { + /** + * The list of publicly documented OAuth scopes that are allowed access. An + * OAuth token containing any of these scopes will be accepted. Example: + * canonical_scopes: https://www.googleapis.com/auth/calendar, + * https://www.googleapis.com/auth/calendar.read + */ + canonicalScopes?: string; + } + /** + * This resource represents a long-running operation that is the result of a + * network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If + * `true`, the operation is completed, and either `error` or `response` is + * available. + */ + done?: boolean; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically + * contains progress information and common metadata such as create time. + * Some services might not provide such metadata. Any method that returns a + * long-running operation should document the metadata type, if any. + */ + metadata?: any; + /** + * The server-assigned name, which is only unique within the same service + * that originally returns it. If you use the default HTTP mapping, the + * `name` should have the format of `operations/some/unique/name`. + */ + name?: string; + /** + * The normal response of the operation in case of success. If the original + * method returns no data on success, such as `Delete`, the response is + * `google.protobuf.Empty`. If the original method is standard + * `Get`/`Create`/`Update`, the response should be the resource. For other + * methods, the response should have the type `XxxResponse`, where `Xxx` is + * the original method name. For example, if the original method name is + * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: any; + } + /** + * The operation metadata returned for the batchend services operation. + */ + export interface Schema$OperationMetadata { + /** + * The full name of the resources that this operation is directly associated + * with. + */ + resourceNames?: string[]; + } + /** + * A protocol buffer option, which can be attached to a message, field, + * enumeration, etc. + */ + export interface Schema$Option { + /** + * The option's name. For protobuf built-in options (options defined in + * descriptor.proto), this is the short name. For example, + * `"map_entry"`. For custom options, it should be the + * fully-qualified name. For example, `"google.api.http"`. + */ + name?: string; + /** + * The option's value packed in an Any message. If the value is a + * primitive, the corresponding wrapper type defined in + * google/protobuf/wrappers.proto should be used. If the value is an enum, + * it should be stored as an int32 value using the + * google.protobuf.Int32Value type. + */ + value?: any; + } + /** + * Represents a documentation page. A page can contain subpages to represent + * nested documentation set structure. + */ + export interface Schema$Page { + /** + * The Markdown content of the page. You can use <code>&#40;== + * include {path} ==&#41;</code> to include content from a + * Markdown file. + */ + content?: string; + /** + * The name of the page. It will be used as an identity of the page to + * generate URI of the page, text of the link to this page in navigation, + * etc. The full page name (start from the root page name to this page + * concatenated with `.`) can be used as reference to the page in your + * documentation. For example: <pre><code>pages: - name: + * Tutorial content: &#40;== include tutorial.md ==&#41; subpages: + * - name: Java content: &#40;== include tutorial_java.md + * ==&#41; </code></pre> You can reference `Java` page using + * Markdown reference link syntax: `Java`. + */ + name?: string; + /** + * Subpages of this page. The order of subpages specified here will be + * honored in the generated docset. + */ + subpages?: Schema$Page[]; + } + /** + * Quota configuration helps to achieve fairness and budgeting in service + * usage. The quota configuration works this way: - The service configuration + * defines a set of metrics. - For API calls, the quota.metric_rules maps + * methods to metrics with corresponding costs. - The quota.limits defines + * limits on the metrics, which will be used for quota checks at runtime. An + * example quota configuration in yaml format: quota: - name: + * apiWriteQpsPerProject metric: library.googleapis.com/write_calls + * unit: "1/min/{project}" # rate limit for consumer projects + * values: STANDARD: 10000 # The metric rules bind all methods + * to the read_calls metric, # except for the UpdateBook and DeleteBook + * methods. These two methods # are mapped to the write_calls metric, + * with the UpdateBook method # consuming at twice rate as the DeleteBook + * method. metric_rules: - selector: "*" metric_costs: + * library.googleapis.com/read_calls: 1 - selector: + * google.example.library.v1.LibraryService.UpdateBook metric_costs: + * library.googleapis.com/write_calls: 2 - selector: + * google.example.library.v1.LibraryService.DeleteBook metric_costs: + * library.googleapis.com/write_calls: 1 Corresponding Metric definition: + * metrics: - name: library.googleapis.com/read_calls display_name: Read + * requests metric_kind: DELTA value_type: INT64 - name: + * library.googleapis.com/write_calls display_name: Write requests + * metric_kind: DELTA value_type: INT64 + */ + export interface Schema$Quota { + /** + * List of `QuotaLimit` definitions for the service. + */ + limits?: Schema$QuotaLimit[]; + /** + * List of `MetricRule` definitions, each one mapping a selected method to + * one or more metrics. + */ + metricRules?: Schema$MetricRule[]; + } + /** + * `QuotaLimit` defines a specific limit that applies over a specified + * duration for a limit type. There can be at most one limit for a duration + * and limit type combination defined within a `QuotaGroup`. + */ + export interface Schema$QuotaLimit { + /** + * Default number of tokens that can be consumed during the specified + * duration. This is the number of tokens assigned when a client application + * developer activates the service for his/her project. Specifying a value + * of 0 will block all requests. This can be used if you are provisioning + * quota to selected consumers and blocking others. Similarly, a value of -1 + * will indicate an unlimited quota. No other negative values are allowed. + * Used by group-based quotas only. + */ + defaultLimit?: string; + /** + * Optional. User-visible, extended description for this quota limit. Should + * be used only when more context is needed to understand this limit than + * provided by the limit's display name (see: `display_name`). + */ + description?: string; + /** + * User-visible display name for this limit. Optional. If not set, the UI + * will provide a default display name based on the quota configuration. + * This field can be used to override the default display name generated + * from the configuration. + */ + displayName?: string; + /** + * Duration of this limit in textual notation. Example: "100s", + * "24h", "1d". For duration longer than a day, only + * multiple of days is supported. We support only "100s" and + * "1d" for now. Additional support will be added in the future. + * "0" indicates indefinite duration. Used by group-based quotas + * only. + */ + duration?: string; + /** + * Free tier value displayed in the Developers Console for this limit. The + * free tier is the number of tokens that will be subtracted from the billed + * amount when billing is enabled. This field can only be set on a limit + * with duration "1d", in a billable group; it is invalid on any + * other limit. If this field is not set, it defaults to 0, indicating that + * there is no free tier for this service. Used by group-based quotas only. + */ + freeTier?: string; + /** + * Maximum number of tokens that can be consumed during the specified + * duration. Client application developers can override the default limit up + * to this maximum. If specified, this value cannot be set to a value less + * than the default limit. If not specified, it is set to the default limit. + * To allow clients to apply overrides with no upper bound, set this to -1, + * indicating unlimited maximum quota. Used by group-based quotas only. + */ + maxLimit?: string; + /** + * The name of the metric this quota limit applies to. The quota limits with + * the same metric will be checked together during runtime. The metric must + * be defined within the service config. + */ + metric?: string; + /** + * Name of the quota limit. The name must be provided, and it must be + * unique within the service. The name can only include alphanumeric + * characters as well as '-'. The maximum length of the limit name + * is 64 characters. + */ + name?: string; + /** + * Specify the unit of the quota limit. It uses the same syntax as + * Metric.unit. The supported unit kinds are determined by the quota backend + * system. Here are some examples: * "1/min/{project}" for quota + * per minute per project. Note: the order of unit components is + * insignificant. The "1" at the beginning is required to follow + * the metric unit syntax. + */ + unit?: string; + /** + * Tiered limit values. You must specify this as a key:value pair, with an + * integer value that is the maximum number of requests allowed for the + * specified unit. Currently only STANDARD is supported. + */ + values?: any; + } + /** + * `SourceContext` represents information about the source of a protobuf + * element, like the file in which it is defined. + */ + export interface Schema$SourceContext { + /** + * The path-qualified name of the .proto file that contained the associated + * protobuf element. For example: + * `"google/protobuf/source_context.proto"`. + */ + fileName?: string; + } + /** + * Source information used to create a Service Config + */ + export interface Schema$SourceInfo { + /** + * All files used during config generation. + */ + sourceFiles?: any[]; + } + /** + * The `Status` type defines a logical error model that is suitable for + * different programming environments, including REST APIs and RPC APIs. It is + * used by [gRPC](https://github.com/grpc). The error model is designed to be: + * - Simple to use and understand for most users - Flexible enough to meet + * unexpected needs # Overview The `Status` message contains three pieces of + * data: error code, error message, and error details. The error code should + * be an enum value of google.rpc.Code, but it may accept additional error + * codes if needed. The error message should be a developer-facing English + * message that helps developers *understand* and *resolve* the error. If a + * localized user-facing error message is needed, put the localized message in + * the error details or localize it in the client. The optional error details + * may contain arbitrary information about the error. There is a predefined + * set of error detail types in the package `google.rpc` that can be used for + * common error conditions. # Language mapping The `Status` message is the + * logical representation of the error model, but it is not necessarily the + * actual wire format. When the `Status` message is exposed in different + * client libraries and different wire protocols, it can be mapped + * differently. For example, it will likely be mapped to some exceptions in + * Java, but more likely mapped to some error codes in C. # Other uses The + * error model and the `Status` message can be used in a variety of + * environments, either with or without APIs, to provide a consistent + * developer experience across different environments. Example uses of this + * error model include: - Partial errors. If a service needs to return + * partial errors to the client, it may embed the `Status` in the normal + * response to indicate the partial errors. - Workflow errors. A typical + * workflow has multiple steps. Each step may have a `Status` message for + * error reporting. - Batch operations. If a client uses batch request and + * batch response, the `Status` message should be used directly inside + * batch response, one for each error sub-response. - Asynchronous + * operations. If an API call embeds asynchronous operation results in its + * response, the status of those operations should be represented directly + * using the `Status` message. - Logging. If some API errors are stored in + * logs, the message `Status` could be used directly after any stripping + * needed for security/privacy reasons. + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number; + /** + * A list of messages that carry the error details. There is a common set + * of message types for APIs to use. + */ + details?: any[]; + /** + * A developer-facing error message, which should be in English. Any + * user-facing error message should be localized and sent in the + * google.rpc.Status.details field, or localized by the client. + */ + message?: string; + } + /** + * Define a parameter's name and location. The parameter may be passed as + * either an HTTP header or a URL query parameter, and if both are passed the + * behavior is implementation-dependent. + */ + export interface Schema$SystemParameter { + /** + * Define the HTTP header name to use for the parameter. It is case + * insensitive. + */ + httpHeader?: string; + /** + * Define the name of the parameter, such as "api_key" . It is + * case sensitive. + */ + name?: string; + /** + * Define the URL query parameter name to use for the parameter. It is case + * sensitive. + */ + urlQueryParameter?: string; + } + /** + * Define a system parameter rule mapping system parameter definitions to + * methods. + */ + export interface Schema$SystemParameterRule { + /** + * Define parameters. Multiple names may be defined for a parameter. For a + * given method call, only one of them should be used. If multiple names are + * used the behavior is implementation-dependent. If none of the specified + * names are present the behavior is parameter-dependent. + */ + parameters?: Schema$SystemParameter[]; + /** + * Selects the methods to which this rule applies. Use '*' to + * indicate all methods in all APIs. Refer to selector for syntax details. + */ + selector?: string; + } + /** + * ### System parameter configuration A system parameter is a special kind of + * parameter defined by the API system, not by an individual API. It is + * typically mapped to an HTTP header and/or a URL query parameter. This + * configuration specifies which methods change the names of the system + * parameters. + */ + export interface Schema$SystemParameters { + /** + * Define system parameters. The parameters defined here will override the + * default parameters implemented by the system. If this field is missing + * from the service config, default system parameters will be used. Default + * system parameters and names is implementation-dependent. Example: define + * api key for all methods system_parameters rules: - + * selector: "*" parameters: - name: api_key + * url_query_parameter: api_key Example: define 2 api key names for a + * specific method. system_parameters rules: - selector: + * "/ListShelves" parameters: - name: + * api_key http_header: Api-Key1 - name: api_key + * http_header: Api-Key2 **NOTE:** All service configuration rules follow + * "last one wins" order. + */ + rules?: Schema$SystemParameterRule[]; + } + /** + * A protocol buffer message type. + */ + export interface Schema$Type { + /** + * The list of fields. + */ + fields?: Schema$Field[]; + /** + * The fully qualified message name. + */ + name?: string; + /** + * The list of types appearing in `oneof` definitions in this type. + */ + oneofs?: string[]; + /** + * The protocol buffer options. + */ + options?: Schema$Option[]; + /** + * The source context. + */ + sourceContext?: Schema$SourceContext; + /** + * The source syntax. + */ + syntax?: string; + } + /** + * Configuration controlling usage of a service. + */ + export interface Schema$Usage { + /** + * The full resource name of a channel used for sending notifications to the + * service producer. Google Service Management currently only supports + * [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification + * channel. To use Google Cloud Pub/Sub as the channel, this must be the + * name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name + * format documented in https://cloud.google.com/pubsub/docs/overview. + */ + producerNotificationChannel?: string; + /** + * Requirements that must be satisfied before a consumer project can use the + * service. Each requirement is of the form + * <service.name>/<requirement-id>; for example + * 'serviceusage.googleapis.com/billing-enabled'. + */ + requirements?: string[]; + /** + * A list of usage rules that apply to individual API methods. **NOTE:** + * All service configuration rules follow "last one wins" order. + */ + rules?: Schema$UsageRule[]; + } + /** + * Usage configuration rules for the service. NOTE: Under development. Use + * this rule to configure unregistered calls for the service. Unregistered + * calls are calls that do not contain consumer project identity. (Example: + * calls that do not contain an API key). By default, API methods do not allow + * unregistered calls, and each method call must be identified by a consumer + * project identity. Use this rule to allow/disallow unregistered calls. + * Example of an API that wants to allow unregistered calls for entire + * service. usage: rules: - selector: "*" + * allow_unregistered_calls: true Example of a method that wants to allow + * unregistered calls. usage: rules: - selector: + * "google.example.library.v1.LibraryService.CreateBook" + * allow_unregistered_calls: true + */ + export interface Schema$UsageRule { + /** + * If true, the selected method allows unregistered calls, e.g. calls that + * don't identify any user or application. + */ + allowUnregisteredCalls?: boolean; + /** + * Selects the methods to which this rule applies. Use '*' to + * indicate all methods in all APIs. Refer to selector for syntax details. + */ + selector?: string; + /** + * If true, the selected method should skip service control and the control + * plane features, such as quota and billing, will not be available. This + * flag is used by Google Cloud Endpoints to bypass checks for internal + * methods, such as service health check methods. + */ + skipServiceControl?: boolean; + } + + + export class Resource$Operations { + root: Serviceusage; + constructor(root: Serviceusage) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * serviceusage.operations.cancel + * @desc Starts asynchronous cancellation on a long-running operation. The + * server makes a best effort to cancel the operation, but success is not + * guaranteed. If the server doesn't support this method, it returns + * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + * or other methods to check whether the cancellation succeeded or whether + * the operation completed despite cancellation. On successful cancellation, + * the operation is not deleted; instead, it becomes an operation with an + * Operation.error value with a google.rpc.Status.code of 1, corresponding + * to `Code.CANCELLED`. + * @alias serviceusage.operations.cancel + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be cancelled. + * @param {().CancelOperationRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + cancel(params?: Params$Resource$Operations$Cancel, options?: MethodOptions): + AxiosPromise; + cancel( + params: Params$Resource$Operations$Cancel, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + cancel( + params: Params$Resource$Operations$Cancel, + callback: BodyResponseCallback): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: Params$Resource$Operations$Cancel| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://serviceusage.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * serviceusage.operations.delete + * @desc 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`. + * @alias serviceusage.operations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be deleted. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete(params?: Params$Resource$Operations$Delete, options?: MethodOptions): + AxiosPromise; + delete( + params: Params$Resource$Operations$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Operations$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Operations$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://serviceusage.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * serviceusage.operations.get + * @desc Gets the latest state of a long-running operation. Clients can use + * this method to poll the operation result at intervals as recommended by + * the API service. + * @alias serviceusage.operations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Operations$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Operations$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Operations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Operations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://serviceusage.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * serviceusage.operations.list + * @desc Lists operations that match the specified filter in the request. If + * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: + * the `name` binding allows API services to override the binding to use + * different resource name schemes, such as `users/x/operations`. To + * override the binding, API services can add a binding such as + * `"/v1/{name=users/x}/operations"` to their service configuration. For + * backwards compatibility, the default name includes the operations + * collection id, however overriding users must ensure the name binding is + * the parent resource, without the operations collection id. + * @alias serviceusage.operations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string=} params.name The name of the operation's parent resource. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Operations$List, options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Operations$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Operations$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Operations$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://serviceusage.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/operations').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Operations$Cancel { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Operations$Delete { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Operations$Get { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Operations$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + + export class Resource$Services { + root: Serviceusage; + constructor(root: Serviceusage) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * serviceusage.services.batchEnable + * @desc Enable multiple services on a project. The operation is atomic: if + * enabling any service fails, then the entire batch fails, and no state + * changes occur. Operation + * @alias serviceusage.services.batchEnable + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Parent to enable services on. An example name would be: `projects/123` where `123` is the project number (not project ID). The `BatchEnableServices` method currently only supports projects. + * @param {().BatchEnableServicesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + batchEnable( + params?: Params$Resource$Services$Batchenable, + options?: MethodOptions): AxiosPromise; + batchEnable( + params: Params$Resource$Services$Batchenable, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + batchEnable( + params: Params$Resource$Services$Batchenable, + callback: BodyResponseCallback): void; + batchEnable(callback: BodyResponseCallback): void; + batchEnable( + paramsOrCallback?: Params$Resource$Services$Batchenable| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Services$Batchenable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Batchenable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://serviceusage.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/services:batchEnable') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * serviceusage.services.disable + * @desc Disable a service so that it can no longer be used with a project. + * This prevents unintended usage that may cause unexpected billing charges + * or security leaks. It is not valid to call the disable method on a + * service that is not currently enabled. Callers will receive a + * `FAILED_PRECONDITION` status if the target service is not currently + * enabled. Operation + * @alias serviceusage.services.disable + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the consumer and service to disable the service on. The enable and disable methods currently only support projects. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not project ID). + * @param {().DisableServiceRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + disable(params?: Params$Resource$Services$Disable, options?: MethodOptions): + AxiosPromise; + disable( + params: Params$Resource$Services$Disable, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + disable( + params: Params$Resource$Services$Disable, + callback: BodyResponseCallback): void; + disable(callback: BodyResponseCallback): void; + disable( + paramsOrCallback?: Params$Resource$Services$Disable| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Services$Disable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Disable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://serviceusage.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:disable') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * serviceusage.services.enable + * @desc Enable a service so that it can be used with a project. + * Operation + * @alias serviceusage.services.enable + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the consumer and service to enable the service on. The `EnableService` and `DisableService` methods currently only support projects. Enabling a service requires that the service is public or is shared with the user enabling the service. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not project ID). + * @param {().EnableServiceRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + enable(params?: Params$Resource$Services$Enable, options?: MethodOptions): + AxiosPromise; + enable( + params: Params$Resource$Services$Enable, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + enable( + params: Params$Resource$Services$Enable, + callback: BodyResponseCallback): void; + enable(callback: BodyResponseCallback): void; + enable( + paramsOrCallback?: Params$Resource$Services$Enable| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Services$Enable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Enable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://serviceusage.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:enable') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * serviceusage.services.get + * @desc Returns the service configuration and enabled state for a given + * service. + * @alias serviceusage.services.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the consumer and service to get the `ConsumerState` for. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not project ID). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Services$Get, options?: MethodOptions): + AxiosPromise; + get(params: Params$Resource$Services$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + get(params: Params$Resource$Services$Get, + callback: BodyResponseCallback): + void; + get(callback: BodyResponseCallback): + void; + get(paramsOrCallback?: Params$Resource$Services$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Services$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://serviceusage.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * serviceusage.services.list + * @desc List all services available to the specified project, and the + * current state of those services with respect to the project. The list + * includes all public services, all services for which the calling user has + * the `servicemanagement.services.bind` permission, and all services that + * have already been enabled on the project. The list can be filtered to + * only include services in a specific state, for example to only include + * services enabled on the project. + * @alias serviceusage.services.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter Only list services that conform to the given filter. The allowed filter strings are `state:ENABLED` and `state:DISABLED`. + * @param {integer=} params.pageSize Requested size of the next page of data. Requested page size cannot exceed 200. If not set, the default page size is 50. + * @param {string=} params.pageToken Token identifying which result to start with, which is returned by a previous list call. + * @param {string} params.parent Parent to search for services on. An example name would be: `projects/123` where `123` is the project number (not project ID). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Services$List, options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Services$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Services$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Services$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Services$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://serviceusage.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/services') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Services$Batchenable { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Parent to enable services on. An example name would be: `projects/123` + * where `123` is the project number (not project ID). The + * `BatchEnableServices` method currently only supports projects. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchEnableServicesRequest; + } + export interface Params$Resource$Services$Disable { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the consumer and service to disable the service on. The enable + * and disable methods currently only support projects. An example name + * would be: `projects/123/services/serviceusage.googleapis.com` where `123` + * is the project number (not project ID). + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DisableServiceRequest; + } + export interface Params$Resource$Services$Enable { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the consumer and service to enable the service on. The + * `EnableService` and `DisableService` methods currently only support + * projects. Enabling a service requires that the service is public or is + * shared with the user enabling the service. An example name would be: + * `projects/123/services/serviceusage.googleapis.com` where `123` is the + * project number (not project ID). + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EnableServiceRequest; + } + export interface Params$Resource$Services$Get { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the consumer and service to get the `ConsumerState` for. An + * example name would be: + * `projects/123/services/serviceusage.googleapis.com` where `123` is the + * project number (not project ID). + */ + name?: string; + } + export interface Params$Resource$Services$List { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Only list services that conform to the given filter. The allowed filter + * strings are `state:ENABLED` and `state:DISABLED`. + */ + filter?: string; + /** + * Requested size of the next page of data. Requested page size cannot + * exceed 200. If not set, the default page size is 50. + */ + pageSize?: number; + /** + * Token identifying which result to start with, which is returned by a + * previous list call. + */ + pageToken?: string; + /** + * Parent to search for services on. An example name would be: + * `projects/123` where `123` is the project number (not project ID). + */ + parent?: string; + } +} diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 99702ab4d96..14b14340041 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -620,6 +620,9 @@ export namespace serviceusage_v1beta1 { * representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} + /** + * Provides error messages for the failing services. + */ export interface Schema$EnableFailure { /** * An error message describing why the service could not be enabled. @@ -942,6 +945,16 @@ export namespace serviceusage_v1beta1 { */ usage?: Schema$Usage; } + /** + * The operation metadata returned for the batchend services operation. + */ + export interface Schema$GoogleApiServiceusageV1OperationMetadata { + /** + * The full name of the resources that this operation is directly associated + * with. + */ + resourceNames?: string[]; + } /** * A service that is available for use by the consumer. */ @@ -1502,6 +1515,10 @@ export namespace serviceusage_v1beta1 { * latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; + /** + * Optional. Metadata which can be used to guide usage of the metric. + */ + metadata?: Schema$MetricDescriptorMetadata; /** * Whether the metric records instantaneous values, changes to a value, etc. * Some combinations of `metric_kind` and `value_type` might not be @@ -1556,6 +1573,28 @@ export namespace serviceusage_v1beta1 { */ valueType?: string; } + /** + * Additional annotations that can be used to guide the usage of a metric. + */ + export interface Schema$MetricDescriptorMetadata { + /** + * The delay of data points caused by ingestion. Data points older than this + * age are guaranteed to be ingested and available to be read, excluding + * data loss due to errors. + */ + ingestDelay?: string; + /** + * The launch stage of the metric definition. + */ + launchStage?: string; + /** + * The sampling period of metric data points. For metrics which are written + * periodically, consecutive data points are stored at this time interval, + * excluding data loss due to errors. Metrics with a higher granularity have + * a smaller sampling period. + */ + samplePeriod?: string; + } /** * Bind API methods to metrics. Binding a method to a metric causes that * metric's configured quota behaviors to apply to the method call. @@ -1787,26 +1826,14 @@ export namespace serviceusage_v1beta1 { response?: any; } /** - * The metadata associated with a long running operation resource. + * The operation metadata returned for the batchend services operation. */ export interface Schema$OperationMetadata { - /** - * Percentage of completion of this operation, ranging from 0 to 100. - */ - progressPercentage?: number; /** * The full name of the resources that this operation is directly associated * with. */ resourceNames?: string[]; - /** - * The start time of the operation. - */ - startTime?: string; - /** - * Detailed status information for each step. The order is undetermined. - */ - steps?: Schema$Step[]; } /** * A protocol buffer option, which can be attached to a message, field, @@ -2118,19 +2145,6 @@ export namespace serviceusage_v1beta1 { */ message?: string; } - /** - * Represents the status of one operation step. - */ - export interface Schema$Step { - /** - * The short description of the step. - */ - description?: string; - /** - * The status code. - */ - status?: string; - } /** * Define a parameter's name and location. The parameter may be passed as * either an HTTP header or a URL query parameter, and if both are passed the diff --git a/src/apis/serviceuser/v1.ts b/src/apis/serviceuser/v1.ts index aa500decb0a..1b273ed7278 100644 --- a/src/apis/serviceuser/v1.ts +++ b/src/apis/serviceuser/v1.ts @@ -1141,6 +1141,10 @@ export namespace serviceuser_v1 { * latencies for successful responses or just for responses that failed. */ labels?: Schema$LabelDescriptor[]; + /** + * Optional. Metadata which can be used to guide usage of the metric. + */ + metadata?: Schema$MetricDescriptorMetadata; /** * Whether the metric records instantaneous values, changes to a value, etc. * Some combinations of `metric_kind` and `value_type` might not be @@ -1195,6 +1199,28 @@ export namespace serviceuser_v1 { */ valueType?: string; } + /** + * Additional annotations that can be used to guide the usage of a metric. + */ + export interface Schema$MetricDescriptorMetadata { + /** + * The delay of data points caused by ingestion. Data points older than this + * age are guaranteed to be ingested and available to be read, excluding + * data loss due to errors. + */ + ingestDelay?: string; + /** + * The launch stage of the metric definition. + */ + launchStage?: string; + /** + * The sampling period of metric data points. For metrics which are written + * periodically, consecutive data points are stored at this time interval, + * excluding data loss due to errors. Metrics with a higher granularity have + * a smaller sampling period. + */ + samplePeriod?: string; + } /** * Bind API methods to metrics. Binding a method to a metric causes that * metric's configured quota behaviors to apply to the method call. @@ -2075,7 +2101,7 @@ export namespace serviceuser_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the consumer and the service to disable for that consumer. The Service User implementation accepts the following forms for consumer: - "project:" A valid path would be: - /v1/projects/my-project/services/servicemanagement.googleapis.com:disable + * @param {string} params.name Name of the consumer and the service to disable for that consumer. The Service User implementation accepts the following forms for consumer: - "project:" A valid path would be: - projects/my-project/services/servicemanagement.googleapis.com * @param {().DisableServiceRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2145,7 +2171,7 @@ export namespace serviceuser_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the consumer and the service to enable for that consumer. A valid path would be: - /v1/projects/my-project/services/servicemanagement.googleapis.com:enable + * @param {string} params.name Name of the consumer and the service to enable for that consumer. A valid path would be: - projects/my-project/services/servicemanagement.googleapis.com * @param {().EnableServiceRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2291,7 +2317,7 @@ export namespace serviceuser_v1 { * Name of the consumer and the service to disable for that consumer. The * Service User implementation accepts the following forms for consumer: - * "project:" A valid path would be: - - * /v1/projects/my-project/services/servicemanagement.googleapis.com:disable + * projects/my-project/services/servicemanagement.googleapis.com */ name?: string; @@ -2309,7 +2335,7 @@ export namespace serviceuser_v1 { /** * Name of the consumer and the service to enable for that consumer. A * valid path would be: - - * /v1/projects/my-project/services/servicemanagement.googleapis.com:enable + * projects/my-project/services/servicemanagement.googleapis.com */ name?: string; diff --git a/src/apis/slides/v1.ts b/src/apis/slides/v1.ts index 7c4aff5ca65..063e01b7d04 100644 --- a/src/apis/slides/v1.ts +++ b/src/apis/slides/v1.ts @@ -473,9 +473,9 @@ export namespace slides_v1 { objectId?: string; } /** - * Creates a video. NOTE: Drive video creation requires that the requesting - * app have at least one of the drive, drive.readonly, or drive.file OAuth - * scopes. + * Creates a video. NOTE: Creating a video from Google Drive requires that + * the requesting app have at least one of the drive, drive.readonly, or + * drive.file OAuth scopes. */ export interface Schema$CreateVideoRequest { /** @@ -490,7 +490,7 @@ export namespace slides_v1 { /** * The video source's unique identifier for this video. e.g. For * YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0, the ID is - * 7U3axjORYZ0. For Drive video + * 7U3axjORYZ0. For a Google Drive video * https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q the ID * is 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q. */ @@ -1417,7 +1417,7 @@ export namespace slides_v1 { */ spaceAbove?: Schema$Dimension; /** - * The amount of extra space above the paragraph. If unset, the value is + * The amount of extra space below the paragraph. If unset, the value is * inherited from the parent. */ spaceBelow?: Schema$Dimension; @@ -2379,9 +2379,9 @@ export namespace slides_v1 { * important to note that the cells specified by a table range do not * necessarily form a rectangle. For example, let's say we have a 3 x 3 * table where all the cells of the last row are merged together. The table - * looks like this: [ ] A table range with + * looks like this: [ ] A table range with * location = (0, 0), row span = 3 and column span = 2 specifies the following - * cells: x x [ x ] + * cells: x x [ x ] */ export interface Schema$TableRange { /** diff --git a/src/apis/sourcerepo/v1.ts b/src/apis/sourcerepo/v1.ts index 692152a01ef..21130c28199 100644 --- a/src/apis/sourcerepo/v1.ts +++ b/src/apis/sourcerepo/v1.ts @@ -124,6 +124,13 @@ export namespace sourcerepo_v1 { * Associates `members` with a `role`. */ export interface Schema$Binding { + /** + * Unimplemented. The condition that is associated with this binding. NOTE: + * an unsatisfied condition will not allow user access via current binding. + * Different bindings, including their conditions, are examined + * independently. + */ + condition?: Schema$Expr; /** * Specifies the identities requesting access for a Cloud Platform resource. * `members` can have the following values: * `allUsers`: A special @@ -142,7 +149,7 @@ export namespace sourcerepo_v1 { members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, - * `roles/editor`, or `roles/owner`. Required + * `roles/editor`, or `roles/owner`. */ role?: string; } @@ -154,6 +161,35 @@ export namespace sourcerepo_v1 { * representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} + /** + * Represents an expression text. Example: title: "User account + * presence" description: "Determines whether the request has a + * user account" expression: "size(request.user) > 0" + */ + export interface Schema$Expr { + /** + * An optional description of the expression. This is a longer text which + * describes the expression, e.g. when hovered over it in a UI. + */ + description?: string; + /** + * Textual representation of an expression in Common Expression Language + * syntax. The application context of the containing message determines + * which well-known feature set of CEL is supported. + */ + expression?: string; + /** + * An optional string indicating the location of the expression for error + * reporting, e.g. a file name and a position in the file. + */ + location?: string; + /** + * An optional title for the expression, i.e. a short string describing its + * purpose. This can be used e.g. in UIs which allow to enter the + * expression. + */ + title?: string; + } /** * Response for ListRepos. The size is not set in the returned repositories. */ diff --git a/src/apis/speech/v1.ts b/src/apis/speech/v1.ts index 4ca41607fea..ddc269eab58 100644 --- a/src/apis/speech/v1.ts +++ b/src/apis/speech/v1.ts @@ -231,13 +231,6 @@ export namespace speech_v1 { * and phrases in the results. */ export interface Schema$SpeechContext { - /** - * Strength of biasing to use (strong, medium or weak). If you use strong - * biasing option then more likely to see those phrases in the results. If - * biasing streangth is not specified then by default medium biasing would - * be used. - */ - biasingStrength?: string; /** * *Optional* A list of strings containing words and phrases * "hints" so that the speech recognition is more likely to diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index ad6650cf02e..77049ea3d12 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -230,9 +230,9 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$CloneContext { /** - * Binary log coordinates, if specified, indentify the the position up to - * which the source instance should be cloned. If not specified, the source - * instance is cloned up to the most recent binary log coordintes. + * Binary log coordinates, if specified, identify the position up to which + * the source instance should be cloned. If not specified, the source + * instance is cloned up to the most recent binary log coordinates. */ binLogCoordinates?: Schema$BinLogCoordinates; /** @@ -538,20 +538,24 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$ExportContext { /** - * Options for exporting data as CSV. + * Options for exporting data as CSV. Exporting in CSV format using the + * Cloud SQL Admin API is not supported for PostgreSQL instances. */ csvExportOptions?: any; /** - * Databases (for example, guestbook) from which the export is made. If - * fileType is SQL and no database is specified, all databases are exported. - * If fileType is CSV, you can optionally specify at most one database to - * export. If csvExportOptions.selectQuery also specifies the database, this - * field will be ignored. + * Databases to be exported. MySQL instances: If fileType is SQL and no + * database is specified, all databases are exported, except for the mysql + * system database. If fileType is CSV, you can specify one database, either + * by using this property or by using the csvExportOptions.selectQuery + * property, which takes precedence over this property. PostgreSQL + * instances: If fileType is SQL, you must specify one database to be + * exported. A fileType of CSV is not supported for PostgreSQL instances. */ databases?: string[]; /** * The file type for the specified uri. SQL: The file contains SQL - * statements. CSV: The file contains CSV data. + * statements. CSV: The file contains CSV data. CSV is not supported for + * PostgreSQL instances. */ fileType?: string; /** @@ -646,24 +650,26 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$ImportContext { /** - * Options for importing data as CSV. + * Options for importing data as CSV. Importing CSV data using the Cloud SQL + * Admin API is not supported for PostgreSQL instances. */ csvImportOptions?: any; /** - * The database (for example, guestbook) to which the import is made. If - * fileType is SQL and no database is specified, it is assumed that the - * database is specified in the file to be imported. If fileType is CSV, it - * must be specified. + * The target database for the import. If fileType is SQL, this field is + * required only if the import file does not specify a database, and is + * overridden by any database specification in the import file. If fileType + * is CSV, one database must be specified. */ database?: string; /** * The file type for the specified uri. SQL: The file contains SQL - * statements. CSV: The file contains CSV data. + * statements. CSV: The file contains CSV data. Importing CSV data using the + * Cloud SQL Admin API is not supported for PostgreSQL instances. */ fileType?: string; /** * The PostgreSQL user for this import operation. Defaults to - * cloudsqlsuperuser. Used only for PostgreSQL instances. + * cloudsqlsuperuser. PostgreSQL instances only. */ importUser?: string; /** @@ -671,9 +677,9 @@ export namespace sqladmin_v1beta4 { */ kind?: string; /** - * A path to the file in Google Cloud Storage from which the import is made. - * The URI is in the form gs://bucketName/fileName. Compressed gzip files - * (.gz) are supported when fileType is SQL. + * A path to the file in Cloud Storage from which the import is made. The + * URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) + * are supported when fileType is SQL. */ uri?: string; } @@ -795,6 +801,10 @@ export namespace sqladmin_v1beta4 { * Whether the instance should be assigned an IP address or not. */ ipv4Enabled?: boolean; + /** + * Reserved for future use. + */ + privateNetwork?: string; /** * Whether SSL connections over IP should be enforced or not. */ @@ -938,10 +948,9 @@ export namespace sqladmin_v1beta4 { kind?: string; } /** - * An Operations resource contains information about database instance - * operations such as create, delete, and restart. Operations resources are - * created in response to operations that were initiated; you never create - * them directly. + * An Operation resource. For successful operations that return an Operation + * resource, only the fields relevant to the operation are populated in the + * resource. */ export interface Schema$Operation { /** @@ -1311,8 +1320,7 @@ export namespace sqladmin_v1beta4 { export interface Schema$SslCertsInsertRequest { /** * User supplied name. Must be a distinct name from the other certificates - * for this instance. New certificates will not be usable until the instance - * is restarted. + * for this instance. */ commonName?: string; } @@ -1375,8 +1383,8 @@ export namespace sqladmin_v1beta4 { */ region?: string[]; /** - * An identifier for the service tier, for example D1, D2 etc. For related - * information, see Pricing. + * An identifier for the machine type, for example, db-n1-standard-1. For + * related information, see Pricing. */ tier?: string; } @@ -2069,7 +2077,7 @@ export namespace sqladmin_v1beta4 { * * @param {object} params Parameters for request * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. - * @param {string} params.project Project ID of the project for which to list Cloud SQL instances. + * @param {string} params.project Project ID of the project that contains the instance. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2341,7 +2349,7 @@ export namespace sqladmin_v1beta4 { */ instance?: string; /** - * Project ID of the project for which to list Cloud SQL instances. + * Project ID of the project that contains the instance. */ project?: string; } @@ -2409,7 +2417,7 @@ export namespace sqladmin_v1beta4 { /** * sql.flags.list - * @desc List all available database flags for Google Cloud SQL instances. + * @desc List all available database flags for Cloud SQL instances. * @alias sql.flags.list * @memberOf! () * @@ -2503,7 +2511,7 @@ export namespace sqladmin_v1beta4 { * @desc Add a new trusted Certificate Authority (CA) version for the * specified instance. Required to prepare for a certificate rotation. If a * CA version was previously added but never used in a certificate rotation, - * this operation replaces that version. There can not be more than one CA + * this operation replaces that version. There cannot be more than one CA * version waiting to be rotated in. * @alias sql.instances.addServerCa * @memberOf! () @@ -2574,8 +2582,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.clone - * @desc Creates a Cloud SQL instance as a clone of the source instance. The - * API is not ready for Second Generation instances yet. + * @desc Creates a Cloud SQL instance as a clone of the source instance. * @alias sql.instances.clone * @memberOf! () * @@ -2711,7 +2718,8 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.demoteMaster - * @desc Reserved for future use. + * @desc Demotes the stand-alone instance to be a Cloud SQL read replica for + * an external database server. * @alias sql.instances.demoteMaster * @memberOf! () * @@ -2782,8 +2790,8 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.export - * @desc Exports data from a Cloud SQL instance to a Google Cloud Storage - * bucket as a MySQL dump file. + * @desc Exports data from a Cloud SQL instance to a Cloud Storage bucket as + * a SQL dump or CSV file. * @alias sql.instances.export * @memberOf! () * @@ -2988,7 +2996,7 @@ export namespace sqladmin_v1beta4 { /** * sql.instances.import - * @desc Imports data into a Cloud SQL instance from a MySQL dump file in Google + * @desc Imports data into a Cloud SQL instance from a SQL dump or CSV file in * Cloud Storage. * @alias sql.instances.import * @memberOf! () @@ -3387,9 +3395,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< /** * sql.instances.resetSslConfig * @desc Deletes all client certificates and generates a new server SSL - * certificate for the instance. The changes will not take effect until the - * instance is restarted. Existing instances without a server certificate - * will need to call this once to set a server certificate. + * certificate for the instance. * @alias sql.instances.resetSslConfig * @memberOf! () * @@ -4606,14 +4612,14 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< /** * sql.sslCerts.delete - * @desc Deletes the SSL certificate. The change will not take effect until - * the instance is restarted. + * @desc Deletes the SSL certificate. For First Generation instances, the + * certificate remains valid until the instance is restarted. * @alias sql.sslCerts.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. - * @param {string} params.project Project ID of the project that contains the instance to be deleted. + * @param {string} params.project Project ID of the project that contains the instance. * @param {string} params.sha1Fingerprint Sha1 FingerPrint. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4751,7 +4757,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< * * @param {object} params Parameters for request * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. - * @param {string} params.project Project ID of the project to which the newly created Cloud SQL instances should belong. + * @param {string} params.project Project ID of the project that contains the instance. * @param {().SslCertsInsertRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4821,7 +4827,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< * * @param {object} params Parameters for request * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. - * @param {string} params.project Project ID of the project for which to list Cloud SQL instances. + * @param {string} params.project Project ID of the project that contains the instance. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4913,7 +4919,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ instance?: string; /** - * Project ID of the project that contains the instance to be deleted. + * Project ID of the project that contains the instance. */ project?: string; /** @@ -4951,8 +4957,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ instance?: string; /** - * Project ID of the project to which the newly created Cloud SQL instances - * should belong. + * Project ID of the project that contains the instance. */ project?: string; @@ -4972,7 +4977,7 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< */ instance?: string; /** - * Project ID of the project for which to list Cloud SQL instances. + * Project ID of the project that contains the instance. */ project?: string; } @@ -4992,8 +4997,8 @@ import(paramsOrCallback?: Params$Resource$Instances$Import|BodyResponseCallback< /** * sql.tiers.list - * @desc Lists all available service tiers for Google Cloud SQL, for example - * D1, D2. For related information, see Pricing. + * @desc Lists all available machine types (tiers) for Cloud SQL, for + * example, db-n1-standard-1. For related information, see Pricing. * @alias sql.tiers.list * @memberOf! () * diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index 8b38c4f5bc6..d5ba7e2686a 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -144,7 +144,7 @@ export namespace testing_v1 { */ export interface Schema$AndroidInstrumentationTest { /** - * The APK for the application under test. Required + * The APK for the application under test. */ appApk?: Schema$FileReference; /** @@ -291,7 +291,7 @@ export namespace testing_v1 { */ export interface Schema$AndroidRoboTest { /** - * The APK for the application under test. Required + * The APK for the application under test. */ appApk?: Schema$FileReference; /** @@ -333,7 +333,7 @@ export namespace testing_v1 { startingIntents?: Schema$RoboStartingIntent[]; } /** - * Configuration that can be selected at the time a test is run. + * Android configuration that can be selected at the time a test is run. */ export interface Schema$AndroidRuntimeConfiguration { /** @@ -352,7 +352,7 @@ export namespace testing_v1 { */ export interface Schema$AndroidTestLoop { /** - * The APK for the application under test. Required + * The APK for the application under test. */ appApk?: Schema$FileReference; /** diff --git a/src/apis/texttospeech/v1beta1.ts b/src/apis/texttospeech/v1beta1.ts index fbb466138b3..bf26b3a89eb 100644 --- a/src/apis/texttospeech/v1beta1.ts +++ b/src/apis/texttospeech/v1beta1.ts @@ -76,6 +76,12 @@ export namespace texttospeech_v1beta1 { * Required. The format of the requested audio byte stream. */ audioEncoding?: string; + /** + * An identifier which selects 'audio effects' profiles that are + * applied on (post synthesized) text to speech. Effects are applied on top + * of each other in the order they are given. + */ + effectsProfileId?: string[]; /** * Optional speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 * semitones from the original pitch. -20 means decrease 20 semitones from diff --git a/src/apis/toolresults/v1beta3.ts b/src/apis/toolresults/v1beta3.ts index b5d542a15ef..9c2a0c2aad3 100644 --- a/src/apis/toolresults/v1beta3.ts +++ b/src/apis/toolresults/v1beta3.ts @@ -1130,6 +1130,10 @@ export namespace toolresults_v1beta3 { * An issue detected occurring during a test execution. */ export interface Schema$TestIssue { + /** + * Category of issue. Required. + */ + category?: string; /** * A brief human-readable message describing the issue. Required. */ diff --git a/src/apis/videointelligence/v1.ts b/src/apis/videointelligence/v1.ts index c8272dfdf6d..1df939af689 100644 --- a/src/apis/videointelligence/v1.ts +++ b/src/apis/videointelligence/v1.ts @@ -189,21 +189,21 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { /** - * Output only. Video file location in [Google Cloud + * Video file location in [Google Cloud * Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Output only. Approximate percentage processed thus far. Guaranteed to be - * 100 when fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when + * fully processed. */ progressPercent?: number; /** - * Output only. Time when the request was received. + * Time when the request was received. */ startTime?: string; /** - * Output only. Time of the most recent update. + * Time of the most recent update. */ updateTime?: string; } @@ -212,9 +212,8 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults { /** - * Output only. Non-streaming error only. If set, indicates an error. Note - * that for a single `AnnotateVideoRequest` some videos may succeed and some - * may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -229,7 +228,7 @@ export namespace videointelligence_v1 { frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Output only. Video file location in [Google Cloud + * Video file location in [Google Cloud * Storage](https://cloud.google.com/storage/). */ inputUri?: string; @@ -388,22 +387,20 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is typically provided only for the top hypothesis, - * and only for `is_final=true` results. Clients should not rely on the - * `confidence` field as it is not guaranteed to be accurate or consistent. - * The default of 0.0 is a sentinel value indicating `confidence` was not - * set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Output only. Transcript text representing the words that the user spoke. + * Transcript text representing the words that the user spoke. */ transcript?: string; /** - * Output only. A list of word-specific information for each recognized - * word. + * A list of word-specific information for each recognized word. */ words?: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; } @@ -412,9 +409,9 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription { /** - * Output only. May contain one or more recognition hypotheses (up to the - * maximum specified in `max_alternatives`). These alternatives are ordered - * in terms of accuracy, with the top (first) alternative being the most + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most * probable, as ranked by the recognizer. */ alternatives?: @@ -425,21 +422,21 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { /** - * Output only. Video file location in [Google Cloud + * Video file location in [Google Cloud * Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Output only. Approximate percentage processed thus far. Guaranteed to be - * 100 when fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when + * fully processed. */ progressPercent?: number; /** - * Output only. Time when the request was received. + * Time when the request was received. */ startTime?: string; /** - * Output only. Time of the most recent update. + * Time of the most recent update. */ updateTime?: string; } @@ -448,9 +445,8 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationResults { /** - * Output only. Non-streaming error only. If set, indicates an error. Note - * that for a single `AnnotateVideoRequest` some videos may succeed and some - * may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -465,7 +461,7 @@ export namespace videointelligence_v1 { frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Output only. Video file location in [Google Cloud + * Video file location in [Google Cloud * Storage](https://cloud.google.com/storage/). */ inputUri?: string; @@ -514,21 +510,21 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo { /** - * Output only. Time offset relative to the beginning of the audio, and - * corresponding to the end of the spoken word. This field is only set if + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if * `enable_word_time_offsets=true` and only in the top hypothesis. This is * an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. Time offset relative to the beginning of the audio, and - * corresponding to the start of the spoken word. This field is only set if + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if * `enable_word_time_offsets=true` and only in the top hypothesis. This is * an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** - * Output only. The word corresponding to this set of information. + * The word corresponding to this set of information. */ word?: string; } @@ -746,21 +742,21 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { /** - * Output only. Video file location in [Google Cloud + * Video file location in [Google Cloud * Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Output only. Approximate percentage processed thus far. Guaranteed to be - * 100 when fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when + * fully processed. */ progressPercent?: number; /** - * Output only. Time when the request was received. + * Time when the request was received. */ startTime?: string; /** - * Output only. Time of the most recent update. + * Time of the most recent update. */ updateTime?: string; } @@ -769,9 +765,8 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationResults { /** - * Output only. Non-streaming error only. If set, indicates an error. Note - * that for a single `AnnotateVideoRequest` some videos may succeed and some - * may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -786,7 +781,7 @@ export namespace videointelligence_v1 { frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Output only. Video file location in [Google Cloud + * Video file location in [Google Cloud * Storage](https://cloud.google.com/storage/). */ inputUri?: string; @@ -822,9 +817,9 @@ export namespace videointelligence_v1 { labelDetectionConfig?: Schema$GoogleCloudVideointelligenceV1_LabelDetectionConfig; /** - * Non-streaming request only. Video segments to annotate. The segments may - * overlap and are not required to be contiguous or span the whole video. If - * unspecified, each video is treated as a single segment. + * Video segments to annotate. The segments may overlap and are not required + * to be contiguous or span the whole video. If unspecified, each video is + * treated as a single segment. */ segments?: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; /** diff --git a/src/apis/videointelligence/v1beta2.ts b/src/apis/videointelligence/v1beta2.ts index e7c569faa89..5706f5dca63 100644 --- a/src/apis/videointelligence/v1beta2.ts +++ b/src/apis/videointelligence/v1beta2.ts @@ -279,21 +279,21 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { /** - * Output only. Video file location in [Google Cloud + * Video file location in [Google Cloud * Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Output only. Approximate percentage processed thus far. Guaranteed to be - * 100 when fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when + * fully processed. */ progressPercent?: number; /** - * Output only. Time when the request was received. + * Time when the request was received. */ startTime?: string; /** - * Output only. Time of the most recent update. + * Time of the most recent update. */ updateTime?: string; } @@ -302,9 +302,8 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults { /** - * Output only. Non-streaming error only. If set, indicates an error. Note - * that for a single `AnnotateVideoRequest` some videos may succeed and some - * may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -319,7 +318,7 @@ export namespace videointelligence_v1beta2 { frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Output only. Video file location in [Google Cloud + * Video file location in [Google Cloud * Storage](https://cloud.google.com/storage/). */ inputUri?: string; @@ -355,9 +354,9 @@ export namespace videointelligence_v1beta2 { labelDetectionConfig?: Schema$GoogleCloudVideointelligenceV1beta2_LabelDetectionConfig; /** - * Non-streaming request only. Video segments to annotate. The segments may - * overlap and are not required to be contiguous or span the whole video. If - * unspecified, each video is treated as a single segment. + * Video segments to annotate. The segments may overlap and are not required + * to be contiguous or span the whole video. If unspecified, each video is + * treated as a single segment. */ segments?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; /** @@ -504,22 +503,20 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { /** - * Output only. The confidence estimate between 0.0 and 1.0. A higher number - * indicates an estimated greater likelihood that the recognized words are - * correct. This field is typically provided only for the top hypothesis, - * and only for `is_final=true` results. Clients should not rely on the - * `confidence` field as it is not guaranteed to be accurate or consistent. - * The default of 0.0 is a sentinel value indicating `confidence` was not - * set. + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. */ confidence?: number; /** - * Output only. Transcript text representing the words that the user spoke. + * Transcript text representing the words that the user spoke. */ transcript?: string; /** - * Output only. A list of word-specific information for each recognized - * word. + * A list of word-specific information for each recognized word. */ words?: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; } @@ -528,9 +525,9 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription { /** - * Output only. May contain one or more recognition hypotheses (up to the - * maximum specified in `max_alternatives`). These alternatives are ordered - * in terms of accuracy, with the top (first) alternative being the most + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most * probable, as ranked by the recognizer. */ alternatives?: @@ -541,21 +538,21 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { /** - * Output only. Video file location in [Google Cloud + * Video file location in [Google Cloud * Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Output only. Approximate percentage processed thus far. Guaranteed to be - * 100 when fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when + * fully processed. */ progressPercent?: number; /** - * Output only. Time when the request was received. + * Time when the request was received. */ startTime?: string; /** - * Output only. Time of the most recent update. + * Time of the most recent update. */ updateTime?: string; } @@ -564,9 +561,8 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationResults { /** - * Output only. Non-streaming error only. If set, indicates an error. Note - * that for a single `AnnotateVideoRequest` some videos may succeed and some - * may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -581,7 +577,7 @@ export namespace videointelligence_v1beta2 { frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Output only. Video file location in [Google Cloud + * Video file location in [Google Cloud * Storage](https://cloud.google.com/storage/). */ inputUri?: string; @@ -630,21 +626,21 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo { /** - * Output only. Time offset relative to the beginning of the audio, and - * corresponding to the end of the spoken word. This field is only set if + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if * `enable_word_time_offsets=true` and only in the top hypothesis. This is * an experimental feature and the accuracy of the time offset can vary. */ endTime?: string; /** - * Output only. Time offset relative to the beginning of the audio, and - * corresponding to the start of the spoken word. This field is only set if + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if * `enable_word_time_offsets=true` and only in the top hypothesis. This is * an experimental feature and the accuracy of the time offset can vary. */ startTime?: string; /** - * Output only. The word corresponding to this set of information. + * The word corresponding to this set of information. */ word?: string; } @@ -770,21 +766,21 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { /** - * Output only. Video file location in [Google Cloud + * Video file location in [Google Cloud * Storage](https://cloud.google.com/storage/). */ inputUri?: string; /** - * Output only. Approximate percentage processed thus far. Guaranteed to be - * 100 when fully processed. + * Approximate percentage processed thus far. Guaranteed to be 100 when + * fully processed. */ progressPercent?: number; /** - * Output only. Time when the request was received. + * Time when the request was received. */ startTime?: string; /** - * Output only. Time of the most recent update. + * Time of the most recent update. */ updateTime?: string; } @@ -793,9 +789,8 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationResults { /** - * Output only. Non-streaming error only. If set, indicates an error. Note - * that for a single `AnnotateVideoRequest` some videos may succeed and some - * may fail. + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. */ error?: Schema$GoogleRpc_Status; /** @@ -810,7 +805,7 @@ export namespace videointelligence_v1beta2 { frameLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Output only. Video file location in [Google Cloud + * Video file location in [Google Cloud * Storage](https://cloud.google.com/storage/). */ inputUri?: string; diff --git a/src/index.ts b/src/index.ts index a1eec2142d3..1575eee9831 100644 --- a/src/index.ts +++ b/src/index.ts @@ -69,6 +69,7 @@ export {cloudfunctions_v1} from './apis/cloudfunctions/v1'; export {cloudfunctions_v1beta2} from './apis/cloudfunctions/v1beta2'; export {cloudiot_v1} from './apis/cloudiot/v1'; export {cloudkms_v1} from './apis/cloudkms/v1'; +export {cloudprofiler_v2} from './apis/cloudprofiler/v2'; export {cloudresourcemanager_v1} from './apis/cloudresourcemanager/v1'; export {cloudresourcemanager_v1beta1} from './apis/cloudresourcemanager/v1beta1'; export {cloudresourcemanager_v2} from './apis/cloudresourcemanager/v2'; @@ -113,7 +114,9 @@ export {drive_v2} from './apis/drive/v2'; export {drive_v3} from './apis/drive/v3'; export {firebasedynamiclinks_v1} from './apis/firebasedynamiclinks/v1'; export {firebaserules_v1} from './apis/firebaserules/v1'; +export {firestore_v1} from './apis/firestore/v1'; export {firestore_v1beta1} from './apis/firestore/v1beta1'; +export {firestore_v1beta2} from './apis/firestore/v1beta2'; export {fitness_v1} from './apis/fitness/v1'; export {fusiontables_v1} from './apis/fusiontables/v1'; export {fusiontables_v2} from './apis/fusiontables/v2'; @@ -128,7 +131,9 @@ export {groupsmigration_v1} from './apis/groupsmigration/v1'; export {groupssettings_v1} from './apis/groupssettings/v1'; export {iam_v1} from './apis/iam/v1'; export {iamcredentials_v1} from './apis/iamcredentials/v1'; +export {iap_v1beta1} from './apis/iap/v1beta1'; export {identitytoolkit_v3} from './apis/identitytoolkit/v3'; +export {indexing_v3} from './apis/indexing/v3'; export {jobs_v2} from './apis/jobs/v2'; export {kgsearch_v1} from './apis/kgsearch/v1'; export {language_v1} from './apis/language/v1'; @@ -174,6 +179,7 @@ export {servicebroker_v1beta1} from './apis/servicebroker/v1beta1'; export {serviceconsumermanagement_v1} from './apis/serviceconsumermanagement/v1'; export {servicecontrol_v1} from './apis/servicecontrol/v1'; export {servicemanagement_v1} from './apis/servicemanagement/v1'; +export {serviceusage_v1} from './apis/serviceusage/v1'; export {serviceusage_v1beta1} from './apis/serviceusage/v1beta1'; export {serviceuser_v1} from './apis/serviceuser/v1'; export {sheets_v4} from './apis/sheets/v4';